Documentation Quality Checklist

Checklist for assessing and improving the quality of technical documentation, especially software documentation such as user manuals, online help files, screencasts, demos and tutorials

When reviewing user manuals or online help files written by yourself or by a colleague, it’s difficult to maintain an objective, unbiased viewpoint. The following checklist helps you maintain this objective viewpoint and bear in mind the key factors.

show/hide sectionGoal-oriented approach
show/hide sectionClarity
show/hide sectionDirect access
show/hide sectionUse of specific media features
show/hide sectionNavigation and search
show/hide sectionTone, unambiguousness
show/hide sectionConsistency, terminology
show/hide sectionStructure in detail
show/hide sectionLayout
show/hide sectionAuthoring process, updates, and translations

Did you benefit from this guide? Did it save you some time compared to search via Google or other search engines? Please help me to keep the guide free and up to date also in the future. Buy a copy of the PDF version (approx. 120 pages).

Thank you.

Order the Technical Documentation Tool and Web Guide

This page was last updated 05/2016