ENL 201 Ch. 19 Instructions and procedures.
Quick reference materials
- Fit on a single page or small card -basic steps
logically order steps
Chronological
Define: procedures
Special type of instruction, serve also as official guidelines
Define: Instructions
To spell out the steps required for completing a task or a series of tasks.
troubleshooting advice
anticipate things that commonly go wrong when the task is performed
Adequate detail
complete but not excessive detail
provide Background
explains Purpose of task
informed content
knowing exactly what you are talking about
Clear and limiting title
-clear and exact preview of the task
Legal implications for instructions
unclear, inaccurate, or incomplete instructions can result in lawsuit
level of detail
-Enough background to understand why they need to follow these instructions -enough detail to show what to do -enough examples so each step can be visualized clearly
Faulty instructions that create legal liability
-Failure to instruct and caution readers in the proper use of a product -failure to warn against hazards from proper use of product -failure to warn against misuse of product -failure to explain a product's benefits and risks in language that average consumers can understand -failure to convey the extent of risk with forceful language -failure to display warnings prominently
Formats of instructions
-Manuals -quick reference materials -assembly guides -web-based instructions -online help
Manuals
-Most comprehensive form of instruction -include use, descriptions, specifications, warnings, and troubleshooting.
What people expect to learn from a set of instructions
-Why am I doing this? -how do I do this? -what materials and equipment will I need? -where do I begin? -What do I do next? -what could go wrong?
main components of instructions
-clear and limiting title -informed content -visuals -appropriate level of detail and technicality
Assembly guides
-common with consumer products -how to assemble parts into a final product -can be 1 page or several -rely heavily on visuals
Online help
-part of most software packages -context sensitive -provide brief explanation -guide you to specific function
web-based instructions
-provide links to other sites -allow for more info beyond basic instructions
readability
-understood on first reading
clear and direct
Verb announces specific action required
State assumptions of readers
What the reader should already know
transitions
first, next, finally
define specialized terms
tell readers what each key term means
general purpose of instructions
to help people perform a task