Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Rules for Sound Documentation
1. Documentation should be written from the point of view of the reader, not the writer.
2. Avoid repetition
3. Avoid unintentional ambiguity.
4. Use a standard organization
5. Record rationale.
6. Keep it current.
7. Review documentation for fitness of purpose.
Ref:
http://www.sei.cmu.edu/reports/00sr004.pdf
http://www.ecs.csun.edu/~rlingard/COMP684/Example2SoftArch.htm#Purpose
https://en.wikipedia.org/wiki/4%2B1_architectural_view_model
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.