The document outlines a two-part checklist for reviewing documents at various stages of development. Part 1 is for reviewing in-process drafts and includes steps like checking screenshots, figure identification, section headings, procedures, content accuracy, and document interfaces. Part 2 adds steps for reviewing completed documents, like checking front matter, the table of contents, headers, footers, cross-references, the index, system requirements, troubleshooting, and overall content flow. The goal is to conduct multiple reviews at different stages using the checklist to catch errors and ensure quality.
The document outlines a two-part checklist for reviewing documents at various stages of development. Part 1 is for reviewing in-process drafts and includes steps like checking screenshots, figure identification, section headings, procedures, content accuracy, and document interfaces. Part 2 adds steps for reviewing completed documents, like checking front matter, the table of contents, headers, footers, cross-references, the index, system requirements, troubleshooting, and overall content flow. The goal is to conduct multiple reviews at different stages using the checklist to catch errors and ensure quality.
The document outlines a two-part checklist for reviewing documents at various stages of development. Part 1 is for reviewing in-process drafts and includes steps like checking screenshots, figure identification, section headings, procedures, content accuracy, and document interfaces. Part 2 adds steps for reviewing completed documents, like checking front matter, the table of contents, headers, footers, cross-references, the index, system requirements, troubleshooting, and overall content flow. The goal is to conduct multiple reviews at different stages using the checklist to catch errors and ensure quality.
The document outlines a two-part checklist for reviewing documents at various stages of development. Part 1 is for reviewing in-process drafts and includes steps like checking screenshots, figure identification, section headings, procedures, content accuracy, and document interfaces. Part 2 adds steps for reviewing completed documents, like checking front matter, the table of contents, headers, footers, cross-references, the index, system requirements, troubleshooting, and overall content flow. The goal is to conduct multiple reviews at different stages using the checklist to catch errors and ensure quality.
PART 1: Use Part 1 of this checklist for all passes necessary to review in-process draft Reviewing documentation, which may comprise individual chapters of a larger document, or In-Process early drafts of a standalone one. Multiple review passes can be made in any Documents order. Steps 1–3 are administrative reviews; steps 4–6 require more technical familiarity. Whenever possible, use change bars to identify any changed sections.
Step Description Actions
1 Screen shots • Compare screen images to on-screen versions. • Compare names and text to on-screen versions. • Check the clarity of images in printed form. 2 Figure • Verify that each caption relates to its figure. identification • For dialog boxes, verify that the complete path or menu sequence needed to open a dialog box appears in the caption or just above the figure. Example: System Manager > Set Up Users. 3 Section • Check that chapter or section headings appear headings correctly in running header/footer information.
• Check that heading levels seem logical and
reasonably consistent.
4 Procedures • Verify accuracy and readability of each step.
• Verify that the steps are in the right sequence and that the procedure as a whole is complete. 5 General content • Check overall accuracy and completeness. • Check overall understandability and usability. • Note any spelling errors, especially in terms or acronyms that a spelling checker might miss. • Verify any questionable style issues against the conventions listed in the following sources: • The “Typeface Conventions” • The “Documentation Style Guide” • Microsoft's Manual of Style for Technical Publications
6 Document • Check the document against the others in the
interfaces library to be sure all of its document interfaces are working correctly. Access documents at: www.xyzcompany.com/documentation.html
After the draft document is complete, use this Part 1 checklist again in addition to the Part 2 checklist to review the final version.
PART 2: Use this Part 2 checklist in addition to Part 1 to review the final documentation. Reviewing Multiple passes can be made in any order. Steps 7–11 are administrative reviews; Completed steps 12–15 require more technical familiarity. Documents Whenever possible, use change bars to identify any changed sections.
Step Description Actions
7 Front matter • Verify company names, addresses, phone numbers, URLs, and e-mail addresses. • Verify disclaimer and warranty statements. • Verify current trademark/registered trademark information via manufacturers’ Web sites. • Verify that the release date is in this format: Documentation release: <version> <mo. yr.> 8 Table of • Check that page numbers point to the correct contents and sections (sample a variety of sections). chapters • Look for obvious TOC omissions or anomalies. • Verify that chapters appear in the correct order.
9 Headers • Check that the document release month and year
appear in the header of all chapters. • Verify that chapter and/or section names appear in alternating page headers and/or footers. 10 Footers • Check the page number continuity throughout.
11 Cross • Verify that cross references point to correct page
references numbers and headings (sample all chapters).
12 Index • Check that the index page numbers point to the
correct sections (sample a variety of entries). • Test usability by attempting to look up a broad variety of key words and ideas. 13 System • In installation or applicable sections, verify that requirements system requirements are correct and reasonable.
14 Troubleshooting • Verify that fixed problems or updated solutions
have been included in the troubleshooting tips. • Verify the accuracy of troubleshooting solutions.
15 Overall content • Check that the flow of information is logical.
and changes • Review any new text or changes to previously incorporated text for mistakes or inaccuracies.
Sample 2-Part Document Review Checklist Adele Sommers ([email protected]) May 2001 2 of 2
