Skip to content

Useful Manuals: Test Real Tasks and Assign Content Maintenance

Summary

Learn to create manuals around real tasks, observe first-time use, document exceptions, and maintain instructions as workflows and user questions change.

Published

Test a Manual in Real Work and Maintain It

Test whether a new user can complete real work with the manual. Include findability, exceptions, and support contacts alongside correct steps.

Assign an update owner and review triggers. A document’s existence does not establish its usefulness in current operations.

State the Goal and Required Preparation

For intake work, state required information, permissions, and the finished state. Explain preparation before users reach a step requiring an unexpected input.

Describe exception conditions and support contacts. Add brief reasons rather than relying only on screenshots.

Observe Someone Using It for the First Time

Let a relevant user perform the task with the document, recording missing information and stopping points. Constant verbal guidance obscures whether the document works independently.

GOV.UK usability testing observes people attempting tasks. (GOV.UK: Moderated usability testing)

Use Changes and Questions to Trigger Updates

Update the manual after changes to interfaces, conditions, or permissions. Repeated questions can reveal missing steps or exceptions.

Public instructions should exclude internal-only information and include an update date and contact route.

When content ownership changes, see work handover.

SpreadSite is a no-code website builder that lets you create, publish, and update a website from Google Sheets using ready-made templates.

To publish a website presenting your approved public instructions, give SpreadSite a try!

Build a website with SpreadSite →

Frequently asked questions

Q: Is expert review sufficient?

A: New users may have different questions. Add a real task trial.

Q: Can a manual contain only screenshots?

A: Explain actions, purposes, and exceptions in text, and maintain it after interface changes.

Q: When should it be updated?

A: Use work changes and user questions as triggers, plus periodic review.

Q: Can an internal manual be published?

A: Create an approved public version without internal records or access details.

Sources

Build a website with Google Sheets using SpreadSite