Writing Procedures

9/7/00


Click here to start


Table of Contents

Writing Procedures

Which is easier to read, this.....?

or this?

Procedures

Where are procedures used?

Write installation instructions as procedures

Write troubleshooting topics as procedures

Write tutorials as procedures

Procedures include four parts

Typical procedure

Procedures

Introductions

Help users choose which procedure they need

Explain difference between procedures

Explain prerequisite procedures

Explain unfamiliar concepts

Procedures

Organize step-by-step instructions

Write steps in the order users must perform them

Write steps in order users must perform them

Include relevant information in the step

Write one step for one action

Write one step for one action

Write one step for one action

Number the steps

Limit number of steps

Divide one long procedure into two

Divide one long procedure into two

Write a separate procedure for duplicate steps

Write a separate procedure for duplicate steps

Combine trivial steps

Procedures

Grammar for steps

Start procedure with a lead-in sentence; let the steps finish the sentence

Tell users where to start and end the procedure

Start steps with a verb (command)

Use same verbs for same actions

Write steps in present tense

Write parallel and active sentences

Write an “If” clause for alternative steps

Follow user interface style

When do I use numbered steps?

Write procedures in numbered steps when

Write procedures in paragraphs when

Write procedures in paragraphs when (continued)

Procedures have too few steps

Procedures

Explanations

Give users information they need to move on to the next step

Describe what user should see after they complete step

Describe options

Describe options

Include code

Alternate way of completing a step

Describe how a feature works if not obvious

Describe unfamiliar concepts

Describe problems user may have when following steps

Tell users what to do after completing steps

Tell users what happens next

Write explanations

If explanation has too many steps, cross-reference a separate procedure

Cross-references to related procedures

Cross-references to related concepts

Writing Exercise

Procedures

Installation guide

Write installation instructions as procedures

Installation instructions

Installation instructions

Write automatic installation procedures

Author: Karin Gallagher

Email: kgallag@rpbourret.com

Home Page: http://www.rpbourret.com/kgallag/index.htm