manuals, instructions, and guides (oh my!) the different documents instructions help reader...
TRANSCRIPT
![Page 1: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/1.jpg)
Manuals, Instructions, and Guides
(oh my!)
![Page 2: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/2.jpg)
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
![Page 3: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/3.jpg)
Different Types of ManualsDifferent Types of Manuals
User’s ManualInstallation ManualMaintenance ManualRepair Manual
For Both Objects/Products and Services/Processes
![Page 4: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/4.jpg)
Remember Your AudienceRemember Your Audience
Knowledge (Skill) Level of Audience
Reading/Language Level of AudienceImportant for Cross-Cultural Documents
![Page 5: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/5.jpg)
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
![Page 6: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/6.jpg)
Safety Issues: Clear Language
Safety Issues: Clear Language
Active VoiceCommands / ImperativesRecognizable Safety Language
Danger!Warning!CautionNote
![Page 7: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/7.jpg)
Figure 20.1 Common Symbols in Safety Information (text page 525)
Safety Issues: DesignSafety Issues: Design
Graphics Color Scheme Simplicity and Recognizability
![Page 8: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/8.jpg)
Figure 20.2 Safety Label (text page 525)
Figure 20.2: Safety label. Source: HCL, Inc., Web site. Used by permission.
![Page 9: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/9.jpg)
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
![Page 10: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/10.jpg)
Process InstructionsProcess Instructions
Clearly Indicate Nature and Scope of Process or Service
Introduce Description of How to Use or Perform (instructions)
Provide DetailsSummary
![Page 11: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/11.jpg)
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?
![Page 12: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/12.jpg)
Process InstructionsProcess Instructions
Organizational Methods
Object / Product Process
Functional or Spatial Chronological or Causal
Graphics Present Tense
![Page 13: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/13.jpg)
Elements of a set of instructions:
General introduction
Step-by-step instructions
Conclusion
InstructionsInstructions
![Page 14: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/14.jpg)
InstructionsInstructions
Intro
Details
Conclusion - Troubleshooting
Why do this? Who? Tools/ MaterialsWhen? Where? Safety
Number Steps Imperative Graphics
![Page 15: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/15.jpg)
ManualsManuals
More Substantial the Instructions
Often a collection of Instructions and Descriptions
More Planning Needed – A Variety of Subordinate Goals
![Page 16: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/16.jpg)
Manuals: Front MatterManuals: Front Matter
Title PagePreface or Intro
WhoWhatPurposeComponents of Manual
Chapter SummaryContact Info / Further Info
![Page 17: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/17.jpg)
BodyBody
Reflect in ToC
Adhere to an Organizing Principle
Apply Tech Design and Writing Principles
![Page 18: Manuals, Instructions, and Guides (oh my!) The Different Documents Instructions Help reader perform a specific task Process Instructions Narrative](https://reader035.vdocument.in/reader035/viewer/2022081821/56649eb75503460f94bc14db/html5/thumbnails/18.jpg)
Back MatterBack Matter
Glossary
Index
Appendix