notes-books-documentingSoftwareArchitectures

seven rules for sound documentation:

1. write from the reader's point of view
2. minimize repetition
3. "avoid ambiguity"
4. "use a standard organization"
5. "record rationale"
6. "keep documentation current but not too current" (meaning, don't change the documentation immediately when a change is made; it should have defined release cycles, times when all of the pending changes are made at once)
7. "review documentation for fitness of purpose"