In Technical Writing: How to Write Software Documentation, Jordan Stanchev shares the outcomes of his research in defining high-quality software documentation. By establishing key performance indicators, it becomes possible to precisely gauge the direction of improvement of any documentation project.
Quality KPIs for docs:
- Helpful
- Comprehensive
- Searchable
- Visual
- Usable
- Readable
- Reliable
- Grammatically correct
- Translatable and localization friendly
- Accessible
- Uses appropriate tone
The scores for these KPIs should stem from User Research and Analysis
