...

• • help documentation contributors
  • provide general background OFBiz help
  • ???

Team Members

The list below is the list of people who are taking part in the OFBiz documentation effort. Please add your details below if you would like to volunteer to help

...

Deepak Nigam

UTC+1

Documentation Reference for Contributors

What tools will they need to install and use

What process will they need to follow?

What templates will they need to use?

...

Documentation Example : Writing Our First Guide Together

...

•  Get the Proof of Concept (PoC) documentation framework written by Taher committed into the trunk (Done by Taher 8th March 2018)
•  Identify mentors who will be available to help less experienced documentation contributors (In progress. Michael, Sharan and Olivier have indicated they are available so far)
•  Use a wiki page to act as reference. (Done, this page is being used as that)
•   High level plan to show what is being done
•  a reference or FAQ for how to get started,
•  Details of the process that we want to follow and also a list of available mentors etc)
•  Define a Table of contents structure for each application (In Progress: Initial one is Human Resources)
•  Mentors will create the document structure within OFBiz (some files with data, some empty)
•  Create Jira tasks for the outstanding documentation work
•  Create some documentation and rules for 'how to write the documentation" (how to use asciidoc syntax for specifics situation, how to use asciidoc syntax for specifics situation
•   

...

BRAINSTORMING AREA

This area is used for adding ideas and suggestions for brainstorming. If the idea or suggestion is move into the task list then it can be deleted from here. Also remove anything that is not relevant.

We can start, in the same time as other documents (Comment from Sharan Foga in response to this. Once we have done an example together so that everyone knows the process and how to work, then we can split off and do parallel work. Trying to do parallel work at the start, I think will cause problems until people are confident enough to work alone)

Documentation Reference for Contributors

What tools will they need to install and use

What process will they need to follow?

What templates will they need to use?

Where are examples of what the documentation should look like? 

     At the beginning this page will be more a draft than a documentation but it can be help us to see if our documentation is usable by us

Doing a small modification on showHelp view to have a header with a link a the main manual (which have links to all the other files )

Michael Brohl:

• We should set up a small documentation quality team which is responsible that the documentation send in by contributors is of good quality, consistent and (mostly) error free. This team should also propose the structure of the documentation and maybe add the empty .adoc files and includes to lead the way for contributors.

• It could also be a good idea to track who is working on a piece of documentation to avoid double work and encourage collaboration between contributors interested in the same topic(s). I think this might be Jira with a main task containing the main "rules" of documentation and several subtasks for each topic.

• I suggest to have also a process to move documentation from the Wiki to the documentation in the repository. We should make sure that we do not have different documentation in both places. If someone is working on a topic he also could search the Wiki for it and try to merge/move it where applicable. Moved/merged documentation from the Wiki should then be moved to an adoc Attic until everthing is cleared and the community agrees to remove it from the Wiki.

• We should also define which contents should be in the repository and what the Wiki should contain or be linked to.

...