...
You can customize this checklist and use it for different purposes. Use this checklist in a technical review to capture changes as a group discusses them. Or, send the checklist to individual reviewers along with a deadline.
Section | Item | Check |
Front Matter/ | Conforms to agreed standard documentation type/title. | |
The purpose of the document is clear and complete. | ||
All known audiences/customers/users are described thoroughly and accurately. | ||
The scope of the document is accurate and complete. | ||
Product version numbers and release dates are accurate. | ||
The table of contents reflects correct page numbers and section names. | ||
Procedure/ Body Text | All steps in the procedure are accurate and complete. (For short procedures.) | |
-or- Step 1 text and screen shots are accurate and complete. (For lengthier procedures and corresponding screen shots.) | ||
-or- Section 1.1 text is accurate and complete. (For sections of body text that are not broken into steps.) | ||
All corresponding screen shots accurately display the current version of the software/clearly relate to the step text. | ||
All charts, graphs, and diagrams are labeled accurately and consistently. | ||
All safety, privacy, and/or other details are specified. | ||
Copy Review | Industry and ONAP terminology used consistently throughout the document (e.g., proper nouns capitalized). | |
Acronyms are spelled out completely in the first instance. | ||
All hyperlinks have been tested and work. | ||
The document flow and structure logical for the audience to follow. | ||
Spelling and grammar check are complete. | ||
The document text is concise and clear. | ||
Standards and Style Review | Follows template structure. | |
Headings match standard font, color, size styles. | ||
Body text matches standard font, color, size styles. |
...