Light Bulb Assignment
Writing Technical Instructions
MEE 6419
Assignment
• Write a set of instructions on how to SAFELY change a compact
fluorescent lightbulb in a home or residence
• You will have 20 minutes to complete the assignment and submit it to
the instructor
• You also have the option to write about:
How to Wash Your Hands
Five basic principles for writing instructions.
• Any professional writing textbook will have a comprehensive section
on writing instructions and manuals, but some basic points to keep in
mind are as follows:
1. Know your audience.
2. Provide a brief introduction.
3. Write each step as a command.
4. Use numbers for commands, bullets for options.
5. Plan to test and revise.
Know your audience
• Most college assignments are written for an ideal reader — an expert
whose job includes reading and correcting everything that you write.
• Don’t expect your real world audience to carefully read your
document as you or your instructors would. People in the real world
read instructions when they are impatient, fatigued, confused, or
even afraid.
• Your writing must be clear enough that readers can understand with
minimal effort. This does not mean using baby language or avoiding
complex details; it does mean using vocabulary appropriate to your
audience, and including details that your readers need to perform the
immediate task.
Provide a brief introduction.
• Help your readers determine, even before opening the brochure or
downloading the web page, whether this document will help them do
whatever it is they want to do.
• State in plain language, what task your document describes: “Installing and Operating the
Canon BJ-200ex Bubble Jet Printer.”
• Concisely state the purpose of the document; who should read it, and
under what circumstances?
• If necessary, you might also explain what your document does not do.
• Remember, most users (especially engineers) will skip the introduction and
go right to the first numbered step. (Don’t put anything vital in the intro!)
• If you wish, you may place extended background information in a subordinate
position that does not interfere with the user’s access to the list of required
actions.
• Note: Technical support documents are no place for marketing slogans —
the reader has already got the product, and is probably 화가나요 with it at the
moment (especially if he/she is an engineer)
Write each step as a command.
• Use the imperative mood —phrase each step as if your reader has just asked,
“Ok, I completed this step, what should I do next?”
• Answer by giving a direct command: “Rotate 2 complete turns.”
• Note: most readers (and nearly all engineers) will skip the introduction and start
reading at the first numbered step.
• If your user will have to know a lot of background information before beginning, put the vital
information into the form of a checklist, rather than a long essay.
• When you are describing steps that must be completed in a certain order,
common sense insists that you start with the first step. Number each step, in
order to emphasize the sequence.
• DO NOT ASSUME THAT PEOPLE EXERCISE, HAVE, OR USE 눈치 있다 (COMMON SENSE)
• Note: when you are providing a list of possibilities, which do not have to come in
any particular order, use bullets instead of numbers
Use Active Voice to Convey Direct Command
“Tab A should be inserted into slot B.”
A reader consults a set of instructions in order to find out what actions to perform, but this
phrasing de-emphasizes the action. Who or what is supposed to insert the tab? This is like
saying “The world’s precious resources should be conserved”? You can agree with that
assertion, but still have no idea how to go about performing the action of conserving.
Consequently, commands should employ the active voice.
“Insert tab A into slot B.”
This revision begins with a verb that specifies what action the reader is supposed to
perform.
Test and Revise.
• Instead of investing your resources into polishing your first
draft, create a prototype and conduct usability testing on it. You’ll be
surprised at how much you can learn.
• As closely as is practical, simulate the environment in which you
intend your audience to follow your instructions.
• Find subject who represents the intended audience, and ask him/her
to follow your instructions.
• Keep quiet and take careful note of any problems.
• Revise your document, and then try again with another volunteer.
• Repeat until you are satisfied with the results
Example
Example
http://www.aspenpitkin.com/Portals/0/docs/City/GreenInitiati
ves/EnergyEfficiency/COA_CFL_lighting.pdf
How to Wash Your Hands
• https://www.prismnet.com/~hcexres/textbook/policies_example.pdf
Assignment
• Write a set of instructions on how to SAFELY change a compact
fluorescent lightbulb
• Remember that CFL bulbs contain mercury which is a toxic substance,
especially for young children and expectant mothers
• You will have 20 minutes to complete the assignment
• Submit before leaving the classroom
• Read https://www.prismnet.com/~hcexres/textbook/instrux.html