Documentation
This stream includes all OFBiz product documentation held currently within Confluence workspaces, wikis.
Documentation Roles
We are looking for volunteers in the following roles:
Authors - to write content
Diagram Converters - to review existing diagrams and help convert them into open source formats
Proofreaders / Editors - to review draft documents and improve them
Translators - to take documents and translate them into other languages
If you are interested in helping in any of these areas please include your details in the table below:
| Volunteer Name | Area of Interest |
|---|
| Sharan Foga | Author, Proofreader, Editor, Diagram Converter |
| Gil Portenseigne | Author, Proofreader, Editor, French Translator |
| Ejaz Ahmed | Proofreader, Editor |
| | |
| | |
| | |
Currently OFBiz has four different workspaces, a public wiki and some online in application help.
- OFBTECH - OFBiz Technical Documentation
- OFBENDUSER - OFBiz End User Documentation
- OFBADMIN - OFBiz Project Administration
- OFBREQDES - OFBiz Requirements and Designs
- OFBiz Public Wiki
- OFBiz documentation from old spaces
- In application online contextual help using DocBook (might move this task into the OFBiz Applications workstream!)
Our objective is to migrate all Confluence documentation from Techncial, End User and Requirements and Designs spaces into the Wiki. Only the Wiki and Project Administration space will remain separate.
Recommended Tools
NOTE: Please use the recommended tools wherever possible |
Other Possible Tools
- Graphviz - General Diagrams
- ArgoUML - UML Diagrams
- Freeplane or FreeMind - Mindmaps
- OpenOffice - General Diagrams
- http://www.neogia.org/wiki/index.php/U.F.O. - Used to quickly make UML diagrams from an OFBiz datamodel instance.
Current High Level Tasks Identified
- Review existing documentation in OFBiz workspaces and update it
- OFBTECH - OFBiz Technical Documentation Workspace : COMPLETE
- OFBENDUSER - OFBiz End User Documentation Workspace : In Progress
- OFBREQDES - OFBiz Requirements and Designs Workspace
- OFBADMIN - OFBiz Project Administration
- Reduce the number of OFBiz Workspaces by moving documentation to the Wiki
- At the end we will have possibly 2 workspaces - I for Project Admin and the Wiki)
- Complete OFBiz Online help
- Complete missing online help for trunk : In Progress
- Review existing online help and update where necessary
- Backport to releases where possible
- Improve OFBIz Online Help interface
- Investigate options for rendering Online Help for trunk