fzieris

We distinguish between two categories of documentation issues: website and source code.
 

How to handle documentation issues

  1. New documentation issues should be listed in the Documentation Issue Tracker
    • set status to "Open"
    • type can be
      • missing information
      • wrong or outdated information
      • other problems with existing documentation, for instance if it's not understandable

    • if you can correct the issue right away just do so

  2. Each documentation issue should be prioritized (see priorities below)

  3. The developer who has the knowledge to correct that issue is responsible to do so
    • please concentrate on the issues with the highest priority first
    • if the issues concerns source code comments ask for a review especially if you have larger comment changes

    • after correcting or completing a documentation issue set the resolution to "Fixed"

  4. The documentation manager should close corrected documentation issues entries after s/he confimed the correction
 

Documentation issue priorities

Sourceforge trackers provide nine priority levels. We only need five, so we only use the odd numbers:
 
Priority
Meaning
9
This issue has to be corrected/completed immediately!
7
This is a very important documentation issue, e.g. a missing package description of a major package or a very important missing or wrong information on the website.
5
This is an important documentation issue, e.g. an interface or a class description is missing/incomplete or information on the website which is not understandable.
3
This is a documentation issue what needs to be taken care of, e.g. a method that needs to be commented.
1
Not prioritized yet - or documentation issues that aren't important but should be noted.