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.

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.

This page was last updated 07/2015

 

Imprint | Privacy | Terms of Use | Copyright | Linking to These Pages | Acknowledgements