in reply to Re: Writing Good Documentation
in thread Writing Good Documentation
- Get reviews, just like code reviews.
This is one of the best ways to be sure your documentation will properly reach its audience. In my experience, it's been best to have at least one person not directly associated with the project review the docs, if possible. Sometimes that's the only way I've realized that one of my assumptions about How The Universe Works is neither common knowledge nor an immutable law of physics. ;)
-rattus
In Section
Meditations