Instructions: the steps, and the people who tried them
Your writing file

Instructions: the steps, and the people who tried them

Two sheets. The steps, one action to a row, with what done looks like, the warning that belongs before the step and any picture it needs. Then a row for each person who followed them, where they stopped and what you changed.

Essential on a first pass only if you are writing instructions: The steps, and one row of Test runs. One person who has never done the task, following your page without help, is the Done when line of Writing instructions. Any other reader can leave both sheets empty.

The steps

One action per row, in the order it happens. A warning goes in the row of the step it warns about, so it is read before the action, not after.

Test runs

One row per person who followed the steps without help. Write where they stopped in their words, not yours.

How to use these sheets

  • One action per row, starting with a verb, in the order it happens. Two verbs joined by "and" are usually two rows.
  • What it looks like when it is done is how the reader knows to move on: a light, a sound, a reading, a screen.
  • A warning goes in the row of the step it warns about, so it is read before the action. That is a convention, explained in Writing instructions.
  • Test runs are written in the tester's words. "Asked which sink" is useful; "got confused" is not.
  • Number the steps on the sheet so you can refer to them in the test log. Renumber when you insert one.
Fictional example

The example rows are the first three steps of Marisol Chen's opening-shift instructions at Valley Hearth Bakery (a fictional plant bakery in Fresno, California). Her first test run, with a packer from the afternoon line who had not worked an opening, found that the handwashing step did not say which sink; she named the sink by the line door and added a photo. The oven step is a check, not a lighting step: the maintenance lead lights the gas ovens. The hot-door warning sits in the row of the step that opens the door, so it is read before the action.

Limits

These sheets hold steps for ordinary tasks. Instructions for electrical, gas, structural, roof, medication or medical work are outside this manual: name the trade or the professional instead. For anything with a maker's manual, the maker's manual is the instruction, and your page points to it.