Access to add and change pages is restricted. See: https://cwiki.apache.org/confluence/display/OFBIZ/Wiki+access

  • Created by Unknown User (sharan), last updated by Unknown User (jleroux) on Jan 08, 2015 2 minute read

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

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 NameArea of Interest
Sharan FogaAuthor, Proofreader, Editor, Diagram Converter
Gil PortenseigneAuthor, Proofreader, Editor, French Translator
Ejaz AhmedProofreader, 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

  1. Review, update and move Technical Documentation to Wiki
  2. Review, update and move End User Documenation to Wiki
  3. Review, update and move Requirements and Designs to Wiki
  • No labels