This document discusses key aspects of writing effective instructional manuals. It explains that instruction manuals provide step-by-step guidance for using consumer products. The three most important elements are analyzing the audience, writing clear step-by-step instructions, and considering how users will organize the information. Safety warnings should also be prominently displayed depending on the level of risk. The overall goal is to make the instructions easy to understand and follow for the intended readers.
This document discusses key aspects of writing effective instructional manuals. It explains that instruction manuals provide step-by-step guidance for using consumer products. The three most important elements are analyzing the audience, writing clear step-by-step instructions, and considering how users will organize the information. Safety warnings should also be prominently displayed depending on the level of risk. The overall goal is to make the instructions easy to understand and follow for the intended readers.
This document discusses key aspects of writing effective instructional manuals. It explains that instruction manuals provide step-by-step guidance for using consumer products. The three most important elements are analyzing the audience, writing clear step-by-step instructions, and considering how users will organize the information. Safety warnings should also be prominently displayed depending on the level of risk. The overall goal is to make the instructions easy to understand and follow for the intended readers.
This document discusses key aspects of writing effective instructional manuals. It explains that instruction manuals provide step-by-step guidance for using consumer products. The three most important elements are analyzing the audience, writing clear step-by-step instructions, and considering how users will organize the information. Safety warnings should also be prominently displayed depending on the level of risk. The overall goal is to make the instructions easy to understand and follow for the intended readers.
Download as PPT, PDF, TXT or read online from Scribd
Download as ppt, pdf, or txt
You are on page 1/ 21
Lecture 2:
Writing Instructional Manuals
MPU32143 English for information technology
1 What is an instructional manual?
is an instructional book or booklet that is supplied with almost all
technologically advanced consumer products such as vehicles, home appliances and computer tools.
2 Analyzing Audience
Background (social, education, demographic)
Skill level Use appropriate vocabulary Translate necessary terms Don’t use jargons
3 The questions readers ask most often What will these instructions help me do? (Introduction) Is there anything special I need to know to be able to use these instructions effectively? (Introduction) If I’m working with equipment, where are the parts I need to use? (Description of the equipment) What materials, equipment, and tools do I need? (List of materials and equipment needed) Once I’m ready to start, what – exactly – do I do? (Directions) Something isn’t working correctly. How do I fix it? (Troubleshooting) 4 People read instructions in one of three ways: 1. Some, read instructions all the way through before beginning to follow any of the steps
2. Others read and perform each
step without looking ahead to the next
3. … others begin a task without
reading any instructions and turn to them only when difficulties arise
5 Don’t forget…
An incorrect audience analysis is the biggest reason why
instructions and manuals fail
Language should always be clear, concise, and brief
Do not use long or complex sentences
6 Elements of Instructions (short version) General introduction
Step-by-step instructions
Conclusion
7 Writing Instructions (intro)
Have reader-centered title (what does the writer have
to do?)
Have a clearly stated purpose that includes reader
benefits
List parts, materials, and conditions
8 Parts, Materials & Conditions
If readers needs to gather items in order to follow the
instructions, list those items in the introduction – Materials are the items needed to perform the task (sandpaper, shellac) – Tools are the implements needed (screwdriver, pliers, small paintbrush) – Conditions are special circumstances that are important for completing the task successfully, such as using a dry, well- ventilated room 9 Writing Instructions (steps)
Number (or otherwise organize) steps
Use present tense and imperative mode Imperatives modes are verbs used to give orders, commands, warning or instructions, and (if you use "please") to make a request. Provide the right amount of info for each step Be specific
10 Be specific
Read a dial
11 Be specific
Read the top dial
12 Be specific
Read the top left dial (in red)
13 Writing Instructions (conclusion) Tell readers what to expect after following the instructions and suggest other uses and options if appropriate
14 Organization & Design
Separate your instructions into logical pieces
(chronological order)
Use relevant instructions/graphics
Make the sections of your instructions visually clear
Separate and label info that isn’t directly part of your
instructions (*note) 15 16 Writing Safety Information
Place in prominent area on the page
The more critical the safety comment, the LARGER and MORE EMPHATIC it should be
17 Levels of Safety defined
Danger – likelihood of serious injury
or death
Warning – potential for
minor/moderate injury
Caution – potential for equipment
damage
Note – suggestions for how to best
carry out the task
18 PRINCIPLES FOR WARNINGS
19 Remember
Know your audience
Keep your instructions simple Start with an introduction Use a clear and effective visual hierarchy DON’T SKIP STEPS JUST BECAUSE THEY SEEM OBVIOUS Conclude with a summary or description 20 The end
