Page History

...

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.

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

Example for Human Resources this will be as follows:

1. humanres.adoc

   1. hr-intro.adoc

   2. hr-employee-evaluations.adoc

   3. hr-glossary.adoc

   4. hr-employee-positions.adoc

   5. hr-employees.adoc

   6. hr-employments.adoc

   7. hr-performance-review.adoc

   8. hr-positions.adoc

   9. hr-qualifications.adoc

   10. hr-recruitment.adoc

   11. hr-skills.adoc

   12. hr-resumes.adoc

   13. hr-training.adoc

   14. hr-leave.adoc

   15. hr-security.adoc

   16. hr-global-settings.adoc

So for the party manager this could be :

1. party.adoc

   1. party-intro.adoc  (NOTE: Do we look at making the short code pty or something shorter than party????)

   2. party-glossary.adoc

   3. party-faq.adoc

   4. party-settings.adoc

   5. party-security.adoc

   6. 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 

...