Latest posts by techwriter (see all)
- Test Your Knowledge of 4 Basic Fonts – Drag & Drop - January 27, 2017
- How NOT to Design a Web Site - January 25, 2017
- Hazards of Poorly Written Technical Documentation - December 26, 2016
Checklists enable technical writers to verify that their documents comply with standards and are consistent and complete.
Checklists are memory aids that can be used at various stages of a project life cycle: Sales, Project and Maintenance. They vary based on industry (e.g., Finance, Software, or Health), document type (e.g., Proposal, User Manual, Presentation, or Online Help) and project requirements (new product or enhancement). Checklists can be in the form of questions or statements. Following are some examples of generic technical writing checklists.
Documentation Project Planning Checklist
Plan before starting a documentation project. What is the project scope? What types of documents are required? In which formats? What is the required deliverable date? Do you have sufficient resources to complete the project? What software and hardware will be required? Who will be the Subject Matter Experts (SMEs)? Who will write? Who will edit? How will the revisions be handled? Where and how will the documentation be stored? How will the documentation be delivered?