2. Manuals, Instructions, and Guides (oh my!)

3. The Different Documents  Instructions  Help reader perform a specific task  Process Instructions  Narrative of an how to use a service or activity  Manuals  More complicated  Usually a compilation of Instructions and Descriptions  Most Common form of Technical Document

4. Different Types of Manuals  User’s Manual  Installation Manual  Maintenance Manual  Repair Manual For Both Objects/Products and Services/Processes

5. Remember Your Audience  Knowledge (Skill) Level of Audience  Reading/Language Level of Audience  Important for Cross-Cultural Documents

6. Plan for safety by: Writing clear safety information Designing safety information Placing safety information in the appropriate location Safety  Perhaps the most important aspect of Manuals  Prevent Loss

7. Safety Issues: Clear Language  Active Voice  Commands / Imperatives  Recognizable Safety Language  Danger!  Warning!  Caution  Note

8. Figure 20.1 Common Symbols in Safety Information (text page 525) Safety Issues: Design  Graphics  Color Scheme  Simplicity and Recognizability

9. Figure 20.2 Safety Label (text page 525 ) Figure 20.2: Safety label. Source: HCL, Inc., Web site. Used by permission.

10. 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: Location  Page Location  Preface info with Safety Warning – NOT AFTER  Set apart from text  Product Location  Clearly associated with product issue

11. Process Instructions  Clearly Indicate Nature and Scope of Process or Service  Introduce Description of How to Use or Perform (instructions)  Provide Details  Summary

12. Process Instructions  Nature and Scope  Usually addressed in clear descriptive title  How to Enroll in Our Frequent Flyer Program  Introduce Description What is Item / Process?How does it Work? What does it Look Like?Principle Parts / Steps? Who Performs / Uses?Graphic Support?

13. Process Instructions  Organizational Methods Object / ProductProcess Functional or SpatialChronological or Causal GraphicsPresent Tense

14. Elements of a set of instructions: General introduction Step-by-step instructions Conclusion Instructions

15.  Intro  Details  Conclusion - Troubleshooting Why do this?Who?Tools/ Materials When?Where?Safety Number StepsImperativeGraphics

16. Manuals  More Substantial the Instructions  Often a collection of Instructions and Descriptions  More Planning Needed – A Variety of Subordinate Goals

17. Manuals: Front Matter  Title Page  Preface or Intro  Who  What  Purpose  Components of Manual  Chapter Summary  Contact Info / Further Info

18. Body  Reflect in ToC  Adhere to an Organizing Principle  Apply Tech Design and Writing Principles

19. Back Matter  Glossary  Index  Appendix