Instructions – Day 2 Parts of a procedure u Introduction Explain purpose Describe when applicable...

Instructions – Day 2

Parts of a procedure Introduction

Explain 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

Software menu options Standard convention for software menus is

to hypenate the words when using multiple levels of menus.

Match menu spelling and wording

Examples of software menus Example

– Insert-Picture-From file– Tools-options

Poor examples– Click Header and Footer under the View menu– Click on Picture under the Insert menu, then

From File.

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.

Multiple levels of instructions Use sub-steps to support various skill levels

in the audience. Make each major step a complete action.

The sub-steps give the details to accomplish that action.

An experienced user can just read the step and other people can follow each sub-step.

Multiple levels of instructions

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?

Explanatory information Provide explanations at the beginning Include minimal explanations of why the

steps are performed with the steps. 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 email me a copy

Practice

Practice

Practice

Practice

End