7.3 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 equipment or other objects. Instructions come in many forms: short emails, standard operating procedures, manuals, user guides, pamphlets, along with webinars and video tutorials. Although they may seem 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 instructions requires the following:

  • clear, precise, and straight-forward 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 in the steps provided
  • willingness to test your instructions on the kind of person you wrote them for

(Instruction Documents, 2013)

Preliminary Steps

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 for your instructions. Remember that defining an audience means defining the level of familiarity your readers have with the topic. So envision your real audience, not your ideal one. Doing so will help you focus on the content that a typical reader would need to perform a sequence of tasks.

2. Do a thorough task analysis

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.

What tasks are involved in the entire procedure?

• Complete a thorough task analysis by performing the task yourself, if possible

• Group related tasks together

• Determine the number of tasks and identify phases

3.  Determine the best approach for the step-by-step section

Figure 7.3.1 an example of instructions written using the task approach. “Post #7: The Importance of First Impressions”, 2014, Georgia State University, http://sites.gsu.edu/techcomm-fall-2014/2014/10/10/post-7-the-importance-of-first-impressions/

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) for instructions on using a phone-answering service, for example, you would include 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.  See Figure 7.3.1 for an example of instructions written using the task approach

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 one button to accomplish the task. Still, there can be times when the tools/feature approach may be preferable.

4.  Design groupings of tasks

Figure 7.3.2. Instructions are divided into multiple sections (phases) with each section containing multiple sub-steps. From “Chapter 8: Technical instructions,” by M. Beilfus, n.d. OKU Library. Creative Commons Licence

 

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 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.

Another example would group common technical tasks as follows:

    1. Unpacking and setup tasks
    2. Installing and customizing tasks
    3. Basic operating tasks
    4. Routine maintenance tasks
    5. Troubleshooting tasks

Knowledge Check

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. Always consider your audience and context first, then adapt your document accordingly.

For alternative formats, check out the Sample Instructions.

A Set of Instructions Often Includes the Following

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, compromising the procedure, and hurting themselves. Also, instructions must often emphasize key points or exceptions. For these situations, you use special notices—general notes, warnings, caution, and danger notices. General warning, caution, and danger notes will appear following the Introduction, and specific notices will appear immediately before any relevant step. Keep in mind that when a procedure involves any hazard to humans or animals, or potential for damage, you have a legal and moral responsibility to include these special notices in the opening and in the discussion of steps in your document.

Technical background or theory:  At the beginning of certain kinds of instructions (after the introduction), you may need background information related to the procedure. For certain instructions, this background is critical—otherwise, the steps in the procedure make no sense.

• In technical contexts, reference to codes, regulations, manufacturer’s datasheets, and other technical documents are required.

• Background on specific knowledge or skills required to perform the tasks should also be included.

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). Be sure to include any personal protective equipment (PPE) (such as masks, steel-toed boots, gloves, and goggles), as this equipment is essential to protect readers when following instructions that may involve hazards. 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, keep in mind the following: 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.

Include a specific note, caution, danger, and warning notices before each relevant step. Placement before the step is the most logical placement because you would not want someone to go ahead and perform a hazardous step without first reading the warning, caution, or danger note.  Notice how these special notices are used in the McMurrey sample instructions (see the link above).

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 in 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 and check that when 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 step are presented. Alternate steps are also used when various conditions might exist. Use nested bulleted lists with this type, with OR inserted between the alternatives, or include a 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.

Figure 7.3.3 an example of how instruction can be written. Remember to see the link above for alternatives.  From “Chapter 8: Technical instructions,” by M. Beilfus, n.d. OKU Library. Creative Commons License

Knowledge Check

Writing Style

Avoid using the passive voice as the trend nowadays is to engage the reader using an active verb that is task-focused. The 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 (also known as the imperative mood) and using “you” to make it perfectly clear what the reader should do. Here is an example:

 

Step 2: Inflating your automobile tires with air

2.1. After driving to the service station, locate the air compressor and park the car next to it.
2.2. Remove the valve stem caps on all four tires.
2.3. Check the PSI number for your vehicle’s tires.
2.4. Turn on the air compressor. (Insert sufficient coinage if necessary).
CAUTION: Do not over-inflate your tires. Doing so will result in faster tread wear and tear.
2.5. Inflate each tire with air from the compressor.
2.6. Check the tire pressure (or PSI) of each tire and adjust using the tire gauge.
2.7. Recap each valve with the valve stem caps.

Note: Each step (except for step 1) begins with a verb in the present tense–the imperative mood. Step 2.1, begins with a qualifier: “After driving to the service station. . .” The step then goes on to use a command style to explain the step.

Also, note the numbering: in technical instructions, use this numerical method for indicating the section or phase each step belongs to: Step 2.1 belongs to Section 2.

Example created by Robin L. Potter

Illustrating Your Instructions

Figure 7.3.4 each instructions includes an illustration of specific step in process. From What Makes a Good Instruction Manual,” by O. Wood, 2013. https://oliverwoodphotography.wordpress.com/2013/05/02/what-makes-a-good-instruction-manual/

You may have noticed that many companies, like Canon and Ikea, now opt for pictorial formats for instructions. In so doing, they are attempting to minimize language barriers when offering their products in countries around the globe. They are also decreasing their costs for translating instructions and minimizing the potential for language errors and content inaccuracies that can occur through the translation process.

Text-based instructions, however, are still common. Perhaps more than in any other form of technical writing, visual aids or visual tutorials are crucial to text-based instructions. Sometimes, words simply cannot explain the step. Illustrations, photographs, screenshots, and the like are often critical to the readers’ ability to visualize what they are supposed to do.  Be sure that the visual aids represent the image from the reader’s perspective. Typically, the visual aids are placed immediately below the step described in the text. Adding visual aids to instructions is about the only time that it is acceptable to be redundant in a technical document. Be sure to include sources for the images if you have not created them yourself.

Formatting Your Instructions

Since people rarely want to read instructions, but often have to, format your instructions for reluctant readers. Try to make your reader want to read them, or at least not resistant to the idea of consulting them.  A highly readable format using headings, listing, passive space, and visual aids 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.

Knowledge Check

 

Revision Checklist for Written Instructions

As you reread and revise your instructions, check that they do the following:

  • Provide an overview of content
  • Indicate audience requirements
  • Clearly describe the exact procedure to be explained
  • Include a section listing equipment and supplies if necessary
  • Include exact measurements and other values when required; for example, “a few drops” is far less specific than “.25 ml”
  • 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 visual aids to illustrate key actions, objects, and locations
  • Provide additional supplementary explanation of the steps as necessary

This chapter was adapted from Online Technical Writing by David McMurrey, which is under a Creative Commons Attribution 4.0 International License.
References

Beilfus, M. (n.d.). Chapter 8: Technical instructions. Technical and professional writing genres. OSU Library. https://open.library.okstate.edu/technicalandprofessionalwriting/chapter/chapter-8/

McMurrey, David. (1997-2017). Online technical writing: Examples, cases, and models. https://www.prismnet.com/~hcexres/textbook/models.html#instructions Creative Commons Attribution 4.0 International License.

McMurrey, David. (1997-2017). Online technical writing: Special notices. https://www.prismnet.com/~hcexres/textbook/notices.html Creative Commons Attribution 4.0 International License.

umnWritingStudies. (2013). Instruction documents. Writing effective steps [Video]. Youtube. https://www.youtube.com/watch?v=h7Qn4GkpcLg&t=192s

License

Icon for the Creative Commons Attribution 4.0 International License

Technical Writing Essentials by Suzan Last is licensed under a Creative Commons Attribution 4.0 International License, except where otherwise noted.

Share This Book