Versions Compared

Key

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

...

Writing the Documentation

Each JIRA wwill have a template or a link to template for the write to use

Writers will attach a text file to the JIRA ticket and add a comment to the ticket that the file is ready for review  (Can we use any existing status to help?_

 

Reviewing Documentation

Reviewers will check for any JIRA tickets ready for review (Not sure if we can use an existing status or rely on notification commnents. Perhaps when a document is started we already assign a reviewer who could also be a mentor....)

Reviewers will read to ensure that the documentation is clear and readable (if they have any queries they can contact the writer)

and check the written documentation and correct any minor grammatical errors

Reviewers may need to contact the writer if the

 

Creating and Testing the Documentation

 

 

Updating Documentation into the Trunk

 

 

Initial  Team Setup Tasks

...