Manuals and procedures · Lesson 29 · Approx. 7 minutes including practice
Usability reviews
Test whether the intended reader can locate and interpret information. Use realistic information-finding tasks without instructing untrained people to operate equipment. Record time, ambiguity and missing links as improvement evidence.
Step 1: Define task
A documentation workflow, not an equipment operating sequence. Animation starts only when you choose Play.
Test information finding before publication
A usability review asks whether the intended reader can locate and interpret the right information. It is different from a technical approval review, although both are important. Choose realistic questions such as locating the applicable parts page or finding the approved maintenance reference. Do not ask untrained participants to operate equipment. Define what counts as a successful answer before the review so observations are comparable.
Prepare and check the work
Give the participant the same document format and navigation they will receive. Record the path taken, confusing labels, dead links and missing applicability information. Avoid coaching them through the first attempt, because that hides the problem. Distinguish a navigation issue from an unresolved technical question. Make changes, repeat a comparable task and report the observations honestly rather than inventing a percentage improvement.
Worked example · demonstration only
A reviewer eventually finds a part number but selects the wrong machine variant. Record that as an unsuccessful identification, even if the search was fast. Improve the applicability cues and retest; speed without correctness is not a useful outcome.
Guided practice and review evidence
Use only a demonstration dataset for this exercise: Ask a reviewer to locate three references in a sample manual and record difficulties. Before starting, write down the question the finished record should answer and identify the source information you would need on a real job. Keep a separate list of missing inputs. Prepare a first draft, then compare it with the topic-specific checks above. Ask another person to follow your references without explaining them verbally. Record where they hesitate, what information they cannot locate and any different interpretation. Keep a brief review log with four columns: observation, proposed action, responsible reviewer and closure evidence. Revise the example and repeat the information-finding check. Your evidence of completion is the revised demonstration record plus that log, not simply time spent reading. Do not upload client information to the academy or practise on operating equipment.
What good completion looks like
A useful result can be understood by someone who did not prepare it. They can identify its purpose, applicable item, source and review status, and they can distinguish confirmed information from unresolved questions. Pay particular attention to this failure mode: Usability review complements technical approval; neither replaces the other. Check the output in the format the recipient will use. A native file, spreadsheet and exported PDF can expose different problems. Keep the source revision and the issued output linked, and record any limitations of the handover. On a real project, follow the customer's authorised checking and approval arrangements before the information is used. The knowledge check below tests understanding of this lesson; it does not assess practical competence or authorise regulated work.
Practical workflow
- Establish the source: identify the approved input, document revision and person responsible for its technical content. Record missing information as an open question.
- Prepare a small representative example before applying the approach to a whole project. Check identifiers, units, references and the intended reader’s needs.
- Ask the nominated reviewer to check technical meaning. Capture the response, resolve comments and issue only under the agreed document-control process.
Review checklist
- Can another reader identify the source and applicable revision?
- Are assumptions and unresolved decisions clearly recorded?
- Is there evidence of the required review before issue?
Educational material and demonstration examples. Not accredited training, practical competency assessment or authority to perform regulated work. Use current approved sources and your responsible technical authority on real projects.