Ch 8 - Instructions and Documentation Flashcards
What are the three types of instructional documentation?
Instructions - how to perform a task
Specifications - exact detail for assembly or process
Procedures and protocols - for consistency
What are the steps to creating Documentation?
1) Make a plan and do research
2) Organize and draft documentation
3) Choose style, design, and medium
What are the eight basic features of most forms of Documentation?
Title Introduction Parts list - tools, materials, and conditions required Safety information Steps to perform Graphics Conclusion (Troubleshooting Information)
Name five components of planning and research for Documentation.
Ask the five W and How questions Subject Purpose Readers & context of use Researching Task
Name six strategies for researching Documentation.
Do background research Make observations Asks subject matter experts Use your senses Describe motion and change Collect visuals
What are the four types of readers of Documentation?
Primary (action takers) - will be performing task
Secondary (advisors) - might supervise or assist
Tertiary (evaluators) - use doc to ensure quality
Gatekeepers (supervisors) - approvers
Name six potential tasks for the introduction of Documentation.
Define subject State purpose Stress importance of task Describe necessary technical ability Identify time required Motivate readers
Name three components of the parts list for Instructions and Procedures
List of parts and materials
List of tools
Any special conditions (humidity, temperature, clean dry surface, etc.)
Name seven recommendations for effective writing of Documentation.
Use command voice - verb first
State one action per step (unless must be completed simultaneously)
Keep steps concise
Number the steps (some specifications and procedures require nested numbering of cautions and notes, as well)
Add comments, notes, or examples
Provide feedback (how to assess progress)
Refer to the graphics
What three types of hazard labeling are included in safety information of documentation?
Danger - serious injury or death
Warning - injury possible if step done improperly
Caution - possible damage to equipment/product
What three things should safety information tell you?
The hazard
Seriousness of hazard
How to avoid injury or damage
Name two standards to use for safety symbols.
International Standards Organization (ISO)
International Electrotechnical Commission (IEC)
Name four potential tasks for the conclusion of documentation.
Signal completion of task
Describe finished product
Mention anything that should have been learned
Provide troubleshooting information
What are four ways to test drafts of Documentation?
read and locate tests
understandability tests
performance tests
safety tests
What’s the three step process for Mapping a Tone for instructions?
1) Evaluate readers’ analysis and identify emotions and attitudes that will shape how they read and use the instructions
2) Use logical mapping to come up with works that are associated with those emotions and attitudes (or antonyms to counter negative ones)
3) Use the words in the introduction, notes, and conclusion
