Improving online documentation from O'Reilly
Posted by kyle_mathews on February 1, 2008 at 5:18pm
Andy Oram recently posted a very interesting article on the O'Reilly Radar on how to improve online documentation. It's a very insightful analysis of the problems that face those writing documentation.
He suggests two tools should be implemented on any online documentation effort:
- Quizzes
- Cross-reference management
He recommends each documentation page include a simple quiz at the end. This is to help monitor quality. If readers aren't answering a question right, this probably means that section of the documentation needs improved.
Read moreSubscribe with RSS 