Often we have several hundred pages of documentation – and nobody seems to understand it. Or the documentation is hopelessly out of date. As a result, little or none documentation is usually created or existing documentation is no longer maintained by the developers. Rarely do we question the reasons for this lack of understanding. With our checklist you can verify in a few minutes whether the existing documentation is properly tailored to the target group and recent.
Please cross the appropriate box for each question that you can answer with a clear “Yes”. Are there certain areas that are not OK? Then you already have the first hints where you can improve your documentation step by step. Ideally, you should do this check regularly so that you can be sure that your documentation is always up to date and targeted towards your goals.
- Gernot Starke about the Principles of technical documentation