-
The source for the document
- The source is text-based, like LaTeX, Markdown, Emacs Org Mode, etc.
-
Follows writing checklist
-
Overall qualities of documentation
- Scope is clear
- Document is abstract (for instance, it does not mention the programming language (unless this is a true constraint) or the algorithm choices (unless the algorithm is the “what” rather than the “how”))
- Output of software is unambiguous
- Inputs to software are unambiguous
- Document is simple (for instance, there is no need for a table of contents)
- Stakeholders are clearly identified
- Environment is clearly identified
- Importance of the problem is convincingly stated
- Goals provide selling features of the product
- Goals are measurable