[Checklist] How to Review Troubleshooting Guides

Making a list, checking it twice… or three times… How do you test your Troubleshooting Guide after you write it? One way is to create a checklist and test each part individually. This also helps System Administrators and Software Testers to double-check that all procedures have been completed correctly. Ok, less talk from me. Let’s […]

User Guide Checklist

This checklist summarizes the recommended structure and contents for User Guide documents. Introduction In this section, introduce the User Guide and cover the following areas: – Intended readers – identify the different user types, for example, system operators, home users, and experts. For each, identify the assumed level of experience and highlight the sections of […]

Functional Specification Checklist

Writing the functional specification occurs after we’ve evaluated the product or technology. If we look at the project planning lifecycle, we can see it’s the second process: Evaluating products. Writing the functional specification. Packaging the master project plan. Creating the master schedule. Reviewing Project Plans. PS – you can download a Functional Specification Checklist template […]

Checklist: how to proofread technical documents in 15 minutes

You have fifteen minutes to check your technical document before it’s sent to the client. What do you do? Start at one page one and read every word out loud? Maybe, maybe not 🙂 Here’s one suggested approach to proofread any type of document when you’re under pressure. Checklist: how to proofread technical documents in […]