Instructions – Day 2

Parts of a procedure u Introduction Explain purpose Describe when applicable u Instruction steps Give steps, results, and required visuals u Optional section Troubleshooting or additional tips u NO conclusion

Chunk the text u Group the text into complete actions –Use headings to break the text up –Keep the user oriented u Chunks come from the task analysis u Think of hierarchy of actions

Software menu options u Standard convention for software menus is to hypenate the words when using multiple levels of menus. u Match menu spelling and wording

Examples of software menus u Example –Insert-Picture-From file –Tools-options u Poor examples –Click Header and Footer under the View menu –Click on Picture under the Insert menu, then From File.

Give results u Tell the user what the step will accomplish. How can they tell it has completed properly u Write in terms of Action/Result u Example Action: Set the CP-3 valve switch to OPEN. Result: The valve indicator light turns red.

Multiple levels of instructions u Use sub-steps to support various skill levels in the audience. u Make each major step a complete action. The sub-steps give the details to accomplish that action. u An experienced user can just read the step and other people can follow each sub-step.

Multiple levels of instructions

Supporting text u Requirements go up front, not with steps –Tool lists –When to accomplish the instructions –Prerequisites for the instructions u Step 7 is not the time to find out a special wrench is needed to remove the part.

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

Explanatory information u Provide explanations at the beginning u Include minimal explanations of why the steps are performed with the steps. u Any explanations must be obviously explanations, so users don’t think they are steps.

Word – Track changes ? Word can track all edits you make Word 2000 Word XP or 2003

Word – Track changes ? Use track changes for the instructions rewrite assignment due next time. ? Make your edits and me a copy

Practice

End