Seven Rules for Sound Documentation

Posted by Ravikiran K.S. on January 1, 2006
  1. Documentation should be written from the point of view of the reader, not the writer.

  2. Avoid unnecessary repetition.

  3. Avoid ambiguity.

  4. Use a standard organization.

  5. Record rationale.

  6. Keep documentation current but not too current.

  7. Review documentation for fitness of purpose.