Manuals, Instructions, and Guides

(oh my!)

The Different DocumentsThe Different Documents

InstructionsHelp reader perform a specific task

Process InstructionsNarrative of an how to use a service or activity

ManualsMore complicatedUsually a compilation of Instructions and DescriptionsMost Common form of Technical Document

Different Types of ManualsDifferent Types of Manuals

User’s ManualInstallation ManualMaintenance ManualRepair Manual

For Both Objects/Products and Services/Processes

Remember Your AudienceRemember Your Audience

Knowledge (Skill) Level of Audience

Reading/Language Level of AudienceImportant for Cross-Cultural Documents

Plan for safety by:

Writing clear safety information

Designing safety information

Placing safety information in the appropriate location

SafetySafety

Perhaps the most important aspect of ManualsPrevent Loss

Safety Issues: Clear Language

Safety Issues: Clear Language

Active VoiceCommands / ImperativesRecognizable Safety Language

Danger!Warning!CautionNote

Figure 20.1 Common Symbols in Safety Information (text page 525)

Safety Issues: DesignSafety Issues: Design

Graphics Color Scheme Simplicity and Recognizability

Figure 20.2 Safety Label (text page 525)

Figure 20.2: Safety label. Source: HCL, Inc., Web site. Used by permission.

Figure 20.3 Safety Information on Machinery (text page 526)

Figure 20.3: Safety information on machinery. Source: John Deere operator’s manual. Reproduced by permission of Deere & Company, © 1995. Deere & Company. All rights reserved.

Safety Issues: LocationSafety Issues: Location

Page LocationPreface info with

Safety Warning – NOT AFTER

Set apart from textProduct Location

Clearly associated with product issue

Process InstructionsProcess Instructions

Clearly Indicate Nature and Scope of Process or Service

Introduce Description of How to Use or Perform (instructions)

Provide DetailsSummary

Process InstructionsProcess Instructions

Nature and ScopeUsually addressed in clear descriptive title

How to Enroll in Our Frequent Flyer Program

Introduce DescriptionWhat is Item / Process? How does it Work?What does it Look Like? Principle Parts / Steps?

Who Performs / Uses? Graphic Support?

Process InstructionsProcess Instructions

Organizational Methods

Object / Product Process

Functional or Spatial Chronological or Causal

Graphics Present Tense

Elements of a set of instructions:

General introduction

Step-by-step instructions

Conclusion

InstructionsInstructions

InstructionsInstructions

Intro

Details

Conclusion - Troubleshooting

Why do this? Who? Tools/ MaterialsWhen? Where? Safety

Number Steps Imperative Graphics

ManualsManuals

More Substantial the Instructions

Often a collection of Instructions and Descriptions

More Planning Needed – A Variety of Subordinate Goals

Manuals: Front MatterManuals: Front Matter

Title PagePreface or Intro

WhoWhatPurposeComponents of Manual

Chapter SummaryContact Info / Further Info

BodyBody

Reflect in ToC

Adhere to an Organizing Principle

Apply Tech Design and Writing Principles

Back MatterBack Matter

Glossary

Index

Appendix