Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  •  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
  •  

...

 

Sample Toc 

 

Brainstorming Ideas

How to get started with planning and organisation?

  • Define a table of contents of the documentation that we want to produce and use it as the document structure within OFBiz.

  • Define target (ordered) for documentation reader and usage (contextual help screen or function or component or "README" by component, function, process, or book or ...)

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 want documents to be small and focussed on one topic (this will make it more re-usable).

We don't want to just copy and paste what we already have

We have a complete HR manual - could we use it as a first set of documents  to all work on together?We can start, in the same time as other documents (

, the "how to write documentation" page/section to be able to  share

...