General Guide: Writing Instructions

The following guidelines are adapted from Prof. Toth's guide to writing instructions. I assume some of you have done this kind of writing in WRT 200 or another class. In this assignment, you are expected to adapt them to your Drupal website and then repost them on this website using the appropriate tag. You can choose any topic for your instructions, but one of the two tech writing assignments needs to be Drupal related.

Specific and Precise Title

The title of your instructions should clearly describe the specific task the reader will complete. A more precise title here would be: “How to Upload Assignments to Blackboard.”

Introduction with Background Information

The length of the introduction depends on the complexity of the task and your readers’ familiarity with it. If the task is simple, your introduction might be only a sentence long. If the task is complex, your introduction might be a few paragraphs long.

  • State the Purpose
  • State the importance of the task
  • Describe the necessary technical ability
  • Identify the time required for completion
  • Motivate the reader

List of Parts, Tools, and Conditions Required

After the introduction, you should list the parts tools, and conditions required for completing the task.

  • List the parts required
  • Identify the tools required
  • Specify Special conditions

Sequentially Ordered Steps

The steps are the centerpiece of any set of instructions, and they will usually make up the bulk of the document.

  • Use command voice
  • State one action per step
  • Keep the steps concise
  • Number the steps
  • Add comments, notes, or examples
  • Provide feedback
  • Refer to the graphics

Safety Information

Safety information should be placed early int he instructions and in places where the reader will be completing difficult or dangerous steps. A common convention is to use three levels:

  • Danger (Signals that readers may be at serious risk of injury.)
  • Warning (Signals that readers may be injured if the step is done improperly.)
  • Caution (Alert that damage could result if the step is done improperly.)
  • Safety information should tell your readers the following three things:
    • the hazard,
    • the seriousness of the hazard, and
    • how to avoid injury or damage.

Conclusion That Signals the Completion of the Task

When you have listed all the steps, you should offer a closing that tells readers that they are finished with the task.

  • Signal completion of the task
  • Describe the finished product
  • Offer troubleshooting advice

Instruction guide adapted from and courtesy of Prof. Toth