Guides to writing step-by-step instructions
These guides are for anyone who writes down how a task in the browser is done, for a colleague, a customer or their own future self. They explain the job itself: planning the steps, wording them, taking the screenshots and keeping the result true.
Each guide answers one question in full, with a worked example and its sources. None of them needs a particular tool.
Topics
-
Process documentation: types, levels and which one to write
What process documentation is, how process descriptions, procedures and work instructions relate, and which of the ten document types to write first.
-
Writing SOPs and step-by-step instructions
What an SOP is, what goes in one, and how to write, test and keep one current for a task in a web app.
-
Screenshots for guides: capture, annotate, redact
When a step needs a screenshot, how to crop and mark it, what to redact and why blur is not enough for secrets.
-
Keeping process documentation private
When screenshots in a guide are personal data, where a recorder sends them, how to check what an extension sends, and how IT approves one.