Phil Druker/Department of English/ University of Idaho

 

Phil Druker/University of Idaho 

Writing instructions:

Here are some general hints to consider when writing instructions:

Writing the individual steps:

1.  Know what you need to do.
2.  Know who your audience is and what level of expertise you expect.
3.  List what you need:  materials and tools.
4. Organize your instructions carefully:

  n      
Divide the project into steps.

n       If the project involves more that 7 steps consider dividing the project into main processes, and then gives steps for completing each main process.

n       Use headings for each main process.

Example:
Process 1.  Finding the Index
                    Step 1.
                    Step 2.
                    Step 3....
Process 2.  Using the Index
                    Step 1
                    Step 2....

5.  Number each step

n       Use chronological order.

6. Follow this basic pattern:
  è
  Instruct.
  è
Then describe. 
      o       
Show what happens?  (Use a figure if necessary)
      o       
Show what should it look like?

7.  Emphasize the result of each step or main process.
8.  Place warnings or notes at useful points.

n       Use bold letters for warnings and notes:
Note: “Warnings” are stronger than “notes.”

Giving the instructions structure:

1.  Give your instructions a title: “How to ….”
2.   State the purpose of your instructions.

  n      
State this concisely on the first line after the instructions.
3. End with troubleshooting hints.
4. Use headings to show main topics/processes. Make the headings specific.

Writing the text:

1.  Use imperative (command) mode to instruct, but ....
2.  Use complete sentences to describe and explain your ideas.
3.  Do not use telegraphic English.

            Wrong:  Place nozzle in receptacle.
            Right:  Place the nozzle in the receptacle.

4.  If you give examples, be sure the readers understand whether you
        have given an example of what they must do or an example showing
        what they can do. 

See a short sample

Testing your instructions:

Ask someone who doesn’t know how to do the process to
        read and follow your instructions.

Revise your instructions based on what your test shows.

 

Back to the tech writing main page.