Versions Compared

Key

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

...

  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 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!)  and
  3. Writers will add a comment to the ticket that the file is ready for review  (Can we use any existing status to help?_)

Reviewing Documentation

  1. 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....)
  2. Reviewers will read to ensure that the documentation is clear and readable (if they have any queries they can contact the writer)
  3. and check the written documentation and correct any minor grammatical errors
  4. Reviewers will then approve the text file as ready to be tested

...