Instructions

Usable instructions

IDG's Dummies guides reveals how most of us feel when we read instructions: like dummies. We read and reread complex sentences, we flip back and forth between pages to relate a picture to a certain point in the text, we scratch our heads and (cursing) fling the book against the wall on the other side of the room.

Parts of a procedure

IntroductionExplain purposeDescribe when applicable

Instruction stepsGive steps, results, and required visuals

Optional sectionTroubleshooting or additional tips

NO conclusion

Chunk the text

Group the text into complete actions– Use headings to break the text up– Keep the user oriented

Chunks come from the task analysis Think of hierarchy of actions

Give results

Tell the user what the step will accomplish. How can they tell it has completed properly

Write in terms of Action/Result Example

Action: Set the CP-3 valve switch to OPEN.

Result: The valve indicator light turns red.

Use expected actions

Use menus and mouse clicks.Don’t user expert/power user short cuts.

Be consistent in terms.

Writing instructions

Use imperative mood (commands)– First word is an action verb

Examples– Turn the knob to 5– NOT: Then you should turn the knob to 5

– Set the switch to ON– NOT: The switch should now be turned ON

Writing instructions

Conditional clauses go first– People read and act in text order

Example– After the light turns red, set the switch to 7.– NOT: Set the switch to 7 after the light turns

red.– NOT: Click on Format Text Box while using

the right mouse key

Each step stands alone

Write the step so it stands alone. Do not use phrases such as

“next,” or “then”. Example:

3. Next click on the drive...6. Then set the blue lever to...

Supporting text

Requirements go up front, not with steps– Tool lists– When to accomplish the instructions– Prerequisites for the instructions

Step 7 is not the time to find out a special wrench is needed to remove the part.

Supporting text

What does pressing shift do?Does the user need to press shift?

End