Telling someone how to do something.
WHAT INSTRUCTIONS MUST ACHIEVE
The reader completes the task, correctly, without asking anyone.
WHAT EACH STEP SHOULD BE
One action Stated as an instruction In the order performed Specific about what to do
WHY ONE ACTION PER STEP
Steps containing several actions are partially completed.
WHAT TO WRITE
The action first.
WHY
Readers performing steps need the verb immediately.
WHAT EXAMPLES SHOW
Not: in order to save the configuration, the save button should be pressed
But: select Save
WHAT TO INCLUDE WITH EACH STEP
Where the thing is, if not obvious What happens as a result, where it matters Anything that could go wrong at that step
WHY WHAT HAPPENS
It confirms the reader is on track.
WHAT TO PUT BEFORE THE STEPS
Prerequisites Warnings about consequences Anything irreversible
WHY WARNINGS BEFORE
A warning after the step is useless.
WHAT TO MARK CLEARLY
Anything that causes data loss, cost or damage.
WHAT TO AVOID
Combining steps to reduce the count Assuming the reader knows where something is Describing the interface rather than the action Optional detail interrupting the sequence
WHAT TO DO ABOUT OPTIONS
Separate them from the main path.
WHY
Branching within a sequence causes readers to lose their place.
WHAT TO ESTABLISH
The most common path, documented as the main sequence.
WHAT TO TEST
Following your own instructions, exactly as written.
WHY EXACTLY
Writers perform steps they did not write.
