Chapter 7 Instructions and Documentation Flashcards
Types of technical documentation
Instructions
Specifications
Procedures/protocols
Instructions and Documentation Basic Features
Title
Introduction
Parts list
Safety information
Steps
Graphics
Conclusion
Use logical mapping for what?
Identifying steps in a task
Writing effective steps
Use command voice
State one action per step
Keep the steps concise
Number the steps
Add comments, notes, or examples
Provide feedback
Refer to the graphics
Labeling hazards
Danger - risk of injury or death
Warning - injury likely if handled improperly
Caution - damage to the product is possible
Graphics should
Reinforce written text
Cultural considerations
use icons carefully
use images carefully
Use basic english
check meanings of names and slogans
translate the text