Page History

...

Documentation Documentation Example : Writing Our First Guide Together

...

1. A JIRA is available to be picked up and worked on if it does not have anyone assigned to it
2. To pick up and start working on a JIRA, assign yourself to a JIRA that that do not have anyone assigned

Writing the Documentation

1. Click the "Start Progress" button and keep it like that as long as you are working on the task. This to let know others that you are actively working on the issue. Possibly click the "Stop Progress" button if you are pausing for this task. You may even unassign yourself if it's for a long period.

Writing the Documentation

1. Each JIRA will have a template or a link to template for the write to use
2. Writers will attach a text file to the JIRA ticket (NOTE: This will not be a patch file: Reasoning is
3. Each JIRA will have a template or a link to template for the write to use
4. Writers will attach a text file to the JIRA ticket (NOTE: This will not be a patch file: Reasoning is that we do not want to lose contributors because they don't understand how to use subversion etc and create patches. The patch creation can be done at a later stage by the editors!)
5. Writers will add a comment to the ticket that the file is ready for review  (Can we use any existing status to help?)

...

1. Editors that are committers will look for tickets that are ready to be committted and commit them into the trunk
2. They will send notifications to the writers and reviewers that the document has been uploaded
3. Editors will close the individual issue

Document Guidelines

Formatting

• Template will be plain text
• Filenames will be in lower case and extension will be .doc
• Text line width set at a maximum of 80 characters (??)
• First line in file will need to include '=' then one space, then the name of the section (e.g. = Timesheets)

Naming

We will be implementing a consistent naming standard for the documentation content files.

Please refer to https://asciidoctor.org/docs/asciidoc-recommended-practices/

Formatting

• Each .adoc file must contain the Apache license header (put between "//// license... ////")
• Recommendation say one sentence per line but are currently doing limiting lines to approx 80 characters... Not sure if are at the one sentence per line stage yet?
• Filenames will be in lower case and extension will be .adoc
• Section titles will use asymmetric atx style (e.g == This is an example of an Asymetric Section Title)
• When including another file using the 'include' directive, please ensure that there is a blank line between each include line (NOTE: From Taher - if we stack directives on top of each other asciidoctor might get confused especially if the headers in the different documents are a different levels)

Naming

We will be implementing a consistent naming standard for the documentation content files.

• Each guide will be named after the component / moduel name (e.g. humanres.adoc, accounting.adoc, manufacturing.adoc, party.adoc etc).
• Lower level files that are in the include directory will include a prefix/shortname indicating the component name, separated by dashes (e.g hr-intro.adoc, hr-glossary.adoc...etc)
• Similar pages will have consistent naming. We will have several intro, glossary, FAQ, settings, security, so the naming format will be ([shortname]-intro, [shortname]-glossary, [shortname]-faq, [shortname]-
• Each guide will be named after the component / moduel name (e.g. humanres.adoc, accounting.adoc, manufacturing.adoc, party.adoc etc).
• Lower level files that are in the include directory will include a prefix/shortname indicating the component name, separated by dashes (e.g hr-intro.adoc, hr-glossary.adoc...etc)
• Similar pages will have consistent naming. We will have several intro, glossary, FAQ, settings, security, so the naming format will be ([shortname]-intro, [shortname]-glossary, [shortname]-faq, [shortname]-settings, [shortname]-security etc.)

...

This could give people a guideline for the base structure and you can immediately recognize what the file contains.

JIRA Issue Task List

Human Resource Guide 

Assigning Yourself A Jira Issue

The first step in the process is looking at the list of open documentation issues / sub tasks and choosing one to work on. Once you have decided to work on an issue, please assign it to yourself. You can do this by:

1. Log into our OFBiz Jira issue tracker

2. Locate the Jira issue you want to work on (Note: Unassigned means that no one is working on it)

3. On the upper right hand side under the ‘People’ section you will see a link that says ‘Assign to me”

4. Click the ‘Assign to me’ link and the issue will be assigned to yourself

You have now assigned yourself to work on an issue.

 Human Resource Guide  JiraserverASF JIRAserverId5aa69414-a9e9-3523-82ec-879b028fb15bkeyOFBIZ-10251

==========================

...

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

...