7. COMMON DOCUMENT TYPES
7.7 Writing Instructions
One of the most common and important uses of technical writing is to provide instructions, those step-by-step explanations of how to assemble, operate, repair, or do routine maintenance on something. Although they may seems intuitive and simple to write, instructions are some of the worst-written documents you can find. Most of us have probably had many infuriating experiences with badly written instructions. This chapter will show you what professionals consider the best techniques in providing instructions.
An effective set of instruction requires the following:
- Clear, precise, and simple writing
- A thorough understanding of the procedure in all its technical detail
- The ability to put yourself in the place of the reader, the person trying to use your instructions
- The ability to visualize the procedure in detail and to capture that awareness on paper
- Willingness to test your instructions on the kind of person you wrote them for.
At the beginning of a project to write a set of instructions, it is important to determine the structure or characteristics of the particular procedure you are going to write about. Here are some steps to follow:
1. Do a careful audience and task analysis
Early in the process, define the audience and situation of your instructions. Remember that defining an audience means defining the level of familiarity your readers have with the topic.
2. Determine the number of tasks
How many tasks are there in the procedure you are writing about? Let’s use the term procedure to refer to the whole set of activities your instructions are intended to discuss. A task is a semi-independent group of actions within the procedure: for example, setting the clock on a microwave oven is one task in the big overall procedure of operating a microwave oven.
A simple procedure like changing the oil in a car contains only one task; there are no semi-independent groupings of activities. A more complex procedure like using a microwave oven contains several semi-independent tasks: setting the clock; setting the power level; using the timer; cleaning and maintaining the microwave, among others.
Some instructions have only a single task, but have many steps within that single task. For example, imagine a set of instructions for assembling a kids’ swing set. In my own experience, there were more than a 130 steps! That can be a bit daunting. A good approach is to group similar and related steps into phases, and start renumbering the steps at each new phase. A phase then is a group of similar steps within a single-task procedure. In the swing-set example, setting up the frame would be a phase; anchoring the thing in the ground would be another; assembling the box swing would be still another.
3. Determine the best approach to the step-by-step discussion
For most instructions, you can focus on tasks, or you can focus on tools (or features of tools). In a task approach (also known as task orientation) to instructions on using a phone-answering service, you’d have these sections:
- Recording your greeting
- Playing back your messages
- Saving your messages
- Forwarding your messages
- Deleting your messages, and so on
These are tasks—the typical things we’d want to do with the machine.
On the other hand, in a tools approach to instructions on using a photocopier, there likely would be sections on how to use specific features:
- Copy button
- Cancel button
- Enlarge/reduce button
- Collate/staple button
- Copy-size button, and so on
If you designed a set of instructions on this plan, you’d write steps for using each button or feature of the photocopier. Instructions using this tools approach are hard to make work. Sometimes, the name of the button doesn’t quite match the task it is associated with; sometimes you have to use more than just the one button to accomplish the task. Still, there can be times when the tools/feature approach may be preferable.
4. Design groupings of tasks
Listing tasks may not be all that you need to do. There may be so many tasks that you must group them so that readers can find individual ones more easily. For example, the following are common task groupings in instructions:
- Unpacking and setup tasks
- Installing and customizing tasks
- Basic operating tasks
- Routine maintenance tasks
- Troubleshooting tasks.
Common Sections in Instructions
The following is a review of the sections you’ll commonly find in instructions. Don’t assume that each one of them must be in the actual instructions you write, nor that they have to be in the order presented here, nor that these are the only sections possible in a set of instructions.
For alternative formats, check out the example instructions.
Introduction: plan the introduction to your instructions carefully. It might include any of the following (but not necessarily in this order):
- Indicate the specific tasks or procedure to be explained as well as the scope (what will and will not be covered)
- Indicate what the audience needs in terms of knowledge and background to understand the instructions
- Give a general idea of the procedure and what it accomplishes
- Indicate the conditions when these instructions should (or should not) be used
- Give an overview of the contents of the instructions.
General warning, caution, danger notices: instructions often must alert readers to the possibility of ruining their equipment, screwing up the procedure, and hurting themselves. Also, instructions must often emphasize key points or exceptions. For these situations, you use special notices—note, warning, caution, and danger notices. Notice how these special notices are used in the example instructions listed above.
Technical background or theory: at the beginning of certain kinds of instructions (after the introduction), you may need a discussion of background related to the procedure. For certain instructions, this background is critical—otherwise, the steps in the procedure make no sense. For example, you may have had some experience with those software applets in which you define your own colors by nudging red, green, and blue slider bars around. To really understand what you’re doing, you need to have some background on color. Similarly, you can imagine that, for certain instructions using cameras, some theory might be needed as well.
Equipment and supplies: notice that most instructions include a list of the things you need to gather before you start the procedure. This includes equipment, the tools you use in the procedure (such as mixing bowls, spoons, bread pans, hammers, drills, and saws) and supplies, the things that are consumed in the procedure (such as wood, paint, oil, flour, and nails). In instructions, these typically are listed either in a simple vertical list or in a two-column list. Use the two-column list if you need to add some specifications to some or all of the items—for example, brand names, sizes, amounts, types, model numbers, and so on.
Discussion of the steps: when you get to the actual writing of the steps, there are several things to keep in mind: (1) the structure and format of those steps, (2) supplementary information that might be needed, and (3) the point of view and general writing style.
Structure and format: normally, we imagine a set of instructions as being formatted as vertical numbered lists. And most are in fact. Normally, you format your actual step-by-step instructions this way. There are some variations, however, as well as some other considerations:
- Fixed-order steps are steps that must be performed in the order presented. For example, if you are changing the oil in a car, draining the oil is a step that must come before putting the new oil. These are numbered lists (usually, vertical numbered lists).
- Variable-order steps are steps that can be performed in practically any order. Good examples are those troubleshooting guides that tell you to check this, check that where you are trying to fix something. You can do these kinds of steps in practically any order. With this type, the bulleted list is the appropriate format.
- Alternate steps are those in which two or more ways to accomplish the same thing are presented. Alternate steps are also used when various conditions might exist. Use bulleted lists with this type, with OR inserted between the alternatives, or the lead-in indicating that alternatives are about to be presented.
- Nested steps may be used in cases when individual steps within a procedure are rather complex in their own right and need to be broken down into sub-steps. In this case, you indent further and sequence the sub-steps as a, b, c, and so on.
- “Step-less” instructions. can be used when you really cannot use numbered vertical list or provide straightforward instructional-style directing of the reader. Some situations must be so generalized or so variable that steps cannot be stated.
Supplementary discussion: often, it is not enough simply to tell readers to do this or to do that. They need additional explanatory information such as how the thing should look before and after the step; why they should care about doing this step; what mechanical principle is behind what they are doing; even more micro-level explanation of the step—discussion of the specific actions that make up the step.
The problem with supplementary discussion, however, is that it can hide the actual step. You want the actual step—the specific actions the reader is to take—to stand out. You don’t want it all buried in a heap of words. There are at least two techniques to avoid this problem: you can split the instruction from the supplement into separate paragraphs; or you can bold the instruction.
Placing the key user steps in bold can a very helpful way to signal clearly what the reader needs to do. Often the command verb is bolded; sometimes bold font highlights the key component being discussed.
Use of the passive voice in instructions can be problematic. For some strange reason, some instructions sound like this: “The Pause button should be depressed in order to stop the display temporarily.” Not only are we worried about the pause button’s mental health, but we wonder who’s supposed to depress the thing (ninjas?). It would be more helpful to indicate when the reader must “press the Pause button.” Consider this example: “The Timer button is then set to 3:00.” Again, one might ask, “is set by whom? Ninjas?” The person following these instructions might think it is simply a reference to some existing state, or she might wonder, “Are they talking to me?” Using the third person can also lead to awkwardness: “The user should then press the Pause button.” Instructions should typically be written using command verb forms and using “you” to make it perfectly clear what the reader should do.
Illustrating Your Instructions
Perhaps more than in any other form of technical writing, graphics are crucial to instructions. Sometimes, words simply cannot explain the step. Illustrations are often critical to the readers’ ability to visualize what they are supposed to do. Be sure that the graphics represent the image from the reader’s perspective.
Formatting Your Instructions
Since people rarely want to read instructions, but often have to, format your instructions for reluctant readability. Try to make your reader want to read them, or at least not resistant to the idea of consulting them. Highly readable format will allow readers who have figured out some of the instructions on their own to skip to the section where they are stuck. Use what you have learned about headings, lists, visuals, and passive space to create effective and readable instructions:
Headings: normally, you’d want headings for any background section you might have, the equipment and supplies section, a general heading for the actual instructions section, and subheadings for the individual tasks or phases within that section.
Lists: similarly, instructions typically make extensive use of lists, particularly numbered vertical lists for the actual step-by-step explanations. Simple vertical lists or two-column lists are usually good for the equipment and supplies section. In-sentence lists are good whenever you give an overview of things to come.
Special Notices: you may have to alert readers to possibilities in which they may damage their equipment, waste supplies, cause the entire procedure to fail, injure themselves or others—even seriously or fatally. Companies have been sued for lack of these special notices, for poorly written special notices, or for special notices that were out of place. See special notices for a complete discussion of the proper use of these special notices as well as their format and placement within instructions.
As you reread and revise your instructions, check that they do the following:
- Clearly describe the exact procedure to be explained
- Provide an overview of content
- Indicate audience requirements
- Use various types of lists wherever appropriate; in particular, use numbered lists for sequential steps
- Use headings and subheadings to divide the main sections and subsections in a logical, coherent order
- Use special notices as appropriate
- Use graphics to illustrate key actions and objects
- Provide additional supplementary explanation of the steps as necessary
- Create a section listing equipment and supplies if necessary.