This checklist helps you test User Guides and other technical documents.
The first step is to ensure the following is in place.
- Setup the necessary technical environment. Make sure this reflects the user’s settings or as close to as possible.
- Print out the procedures. Follow the instructions as per the document. Aim to identify any gaps in the steps. Likewise, see if additional notes or warnings should be added.
- Examine the screenshots. Does these provide real value? Do the screenshots reflect how the window or dialog box are populated? Is there data in the screenshots? If not, replace with something more meaningful.
- Does the introduction orient the reader?
- Does it highlight the necessary and mandatory prerequisites that must be performed?
- Are the sections in a logical order? For example, is it arranged based on the user interface layout or on commonly performed tasks?
- Is there an index? Are the entries used in a meaningful way?
- If online, have meaningful keywords been added to the search engine?
- Comprehensive – are all scenarios covered in the document? In other words, in addition to checking that the materials in the document are correct, you have to consider if other procedures are missing? To do this, you need to examine the application and see if, from a user’s point of view, if all tasks have been documented.
User Guide Checklist
After this, examine the document using the following checklist.
Have you provided visual cues to help the reader use the manual, understand concepts, and help them digest information faster?
You can achieve this by using some of the following:
Support Different Learners
Have you developed content that supports the following learning methods:
Provide the following types of examples to help the reader understand the materials:
1. Concrete examples, for example, how to perform a specific task.
2. Abstract concepts
Have you delivered the user guide in a file format the suits the reader? For example, do they want the document in PDF or as Online Help or both?
Other factors to consider include:
1. Size – remember to optimize the PDF before publishing and to ensure it downloads fast.
2. Online/print – prepare the document in both online and PDF, if necessary.
3. Software/hardware environment – will the reader need any special software to view the documents?
4. Binding – if delivering a hardcopy, make sure the binding is reliable, so pages donâ€™t fall out after a little use.
5. Protection – if the document will be used outdoors, make sure it is weather-proof.
Have you checked that the guide includes the following?
1. Headers, footers, navigation bars
2. Table of contents
3. Cross-references/links to related procedures/documents
4. Is each topic self-contained? In other words, can you perform the task from start to finish without having to go to another page?
5. Is there adequate white space?
6. Have you avoided large blocks of text?
7. Does the document separate conceptual, procedures, and reference materials?
9. Glossary with product terminology and industry terms
In this section, you should introduce the User Guide and cover the following areas:
1. Intended readers – have you identified the different user types, for example, system operators, home users, and experts?
2. Have you identified the assumed level of experience and highlighted the sections of user guide which apply to them.
3. Software version – is the software release the User Guide refers to identified?
4. Purpose – have you described the purpose of the system and User Guide?
5. How to use User Guide document – have you described the intended use, section contents and relationship between sections?
6. Related documents – have you identified related documents?
7. Conventions – have you described symbols, conventions and syntax conventions used in the guide?
8. Problem reporting instructions – provided an email address so readers can contact you if they find an error or omission?
Have you outlined how the system works at a high level?
1. Identified key functions?
2. Inputs and Outputs – identified inputs what you, the reader, need to enter, and outputs, what you expect in response, for example, reports?
3. Provided further detailed explanation, if necessary.
4. Assumptions on user expertise, for example, experience or proficiency in related areas or previous training.
This is usually the heart of the user guide. For each task, document the following:
1. Explain how to get started, for example, specific settings they need to make to use the application, such as installing a plugin or checking that a specific version of Java has been installed.
2. Describe the different functions of the system.
3. Provide cautions, warnings, and recommendations.
4. For each procedures, identify where in the application you perform this task, input operations and expected results. If necessary, include a screenshot that helps the reader understand the task. Avoid pointless eye candy screenshots.
5. Required parameters, optional parameters, default options and order/syntax
6. Provide examples
7. Identify known issue, likely errors, possible causes, and resolutions.
Have you identified and described all system capabilities, for example,
1. Describe the purpose of different buttons on the menu bars, what happens if they get greyed-out, how to change this, why this occurred, and how to reset window layout.
2. Describe the purpose of each field, identify mandatory settings, minimum or maximum settings, recommendations, and data input types.
Error Messages and Recovery Procedures
Have you identified and described all error messages and recovery procedures, for example,
1. Document all error messages.
2. Identify root cause.
3. Suggest recovery procedures
Have you provided a list of ambiguous terms or terms users may not know to the reader.
Have you provided an index? This is recommended for User Guides of 40 pages or more.
Have you provided Document Control, Signoff and Change Record information?