Instruction Paper
wlwlli
heuristic_checklist_for_instructions_components.docx
|
Section of Document |
Component |
Purpose |
Is the component present in the document? |
If yes – what revisions are needed (if any)? If no – should it be added? |
|
Preliminary or Introductory Information
|
Title |
Provides the main topic at a glance |
|
|
|
|
Legal Information |
States copyright, trademarks, disclaimers, etc. |
|
|
|
|
Safety Information |
States environmental conditions or personal injury conditions to be aware of |
|
|
|
|
Table of Contents |
List major and minor sections for access |
|
|
|
|
List of Needed Items |
States equipment, tools, and materials, needed to complete task |
|
|
|
|
List of Provided Items |
States any equipment, tools, or materials provided to complete task |
|
|
|
|
Prerequisites to Complete Task |
State skills, experience level, education/certifications needed to complete task |
|
|
|
|
Time to Complete Task |
States approximate time to complete task |
|
|
|
|
Purpose & Goals Statements |
Explain the purpose of the document and/or goals the reader will accomplish |
|
|
|
|
Overview Statement |
Explains the whole meaning of the document (process, product, etc.) |
|
|
|
|
Rationale Statement |
Explains why something is done in a specific way or the philosophy behind actions |
|
|
|
|
Approval Notice & Date |
Indicates authority to implement actions |
|
|
|
Section of Document |
Component |
Purpose |
Is the component present in the document? |
If yes – what revisions are needed (if any)? If no – should it be added? |
|
Primary Information
|
Step-by-step Instructions |
Instructs how to complete a task |
|
|
|
|
Process Descriptions |
Explains how a process, object, or mechanism works |
|
|
|
|
Definitions & Descriptions |
Explains what a term means or how an object/mechanism appears |
|
|
|
|
Specifications & Standards |
Identifies specific measurements and/or norms for a product or process |
|
|
|
|
Graphics & Figures |
Provide visual elements to illustrate products/processes |
|
|
|
Secondary Information
|
Tips & Notes |
Provide helpful and useful suggestions |
|
|
|
|
Warning, Danger, & Caution Signals |
Inform about hazardous situations |
|
|
|
|
Examples & Explanations |
Show application of concepts in detail |
|
|
|
|
System Responses or Reactionary Notes |
Explain what the reader can expect to happen after completing a task |
|
|
|
|
References & Cross-references |
Provide supplemental information for further research or show connections to other related material |
|
|
|
Concluding Information
|
Note of Completing Task |
Indicates the end of a process |
|
|
|
|
Thank You Note |
Shows appreciation towards the reader |
|
|
|
|
Summary of Main Points |
Reiterates the most crucial ideas |
|
|
|
|
Relationship to Other Documents or Products |
References documents or products that are related to the product or process |
|
|
|
|
Technical Support & Troubleshooting Info |
Provide help scenarios and contact details for support |
|
|
|
|
Recommendations for Additional Reading |
Suggest related readings |
|
|
|
|
Glossary of Terms |
Defines specialized terms used in the document |
|
|
|
|
Index |
Identifies page location for topics mentioned in the document |
|
|
