Difference between revisions of "Instructions"

From CompSciWiki
Jump to: navigation, search
Line 8: Line 8:
  
 
==Guidelines for Instructions==
 
==Guidelines for Instructions==
Text!
+
The text covers several guidelines for writing good instructions.  Here we will emphasize how each guideline can assist the reader and avoid frustration.
 +
 
 +
 
 +
====An Example====
 +
Below are example instructions that employ nearly all of the guidelines; this example will be referred to throughout the page.
 +
 
 +
These instructions detail the preparation a Blizzard/McFlurry (or other similar ice cream or frozen yogurt treat) using given fast-food machinery, for the purpose of serving a customer.  The presumed audience is someone completely new to the process of making this delicious item, who has little or no outside assistance at the moment.  As such, the instructions need to be thorough, as well as easy to understand and follow.  ''Note: These instructions assume the reader already has the required machinery and materials at hand.''
 +
 
 +
 
 +
<small>
 +
'''Making a Blizzard'''
 +
 
 +
 
 +
Intro.
 +
 
 +
Materials needed:
 +
* material 1
 +
* material 2
 +
* material 3
 +
 
 +
 
 +
: 1. Fit metal shield on to top of a fresh cup.
 +
Filling the cup:
 +
: 2. Fill cup half-way with ice cream.
 +
: 3. Add toppings.
 +
: 4. Fill cup to the top with ice cream
 +
:: ''Note: It is ok if the ice cream is filled above the cup's rim.''
 +
Blending:
 +
: 5. Position cup underneath blender so that the rod is inside the ice cream.
 +
: 6. Simultaneously:
 +
:* Gently push down blender pedal with your foot.
 +
:* Slowly move cup up/down to mix the entire contents.
 +
: 7. Lower cup so the rod is no longer in the ice cream, keeping pressure on the foot pedal.
 +
:: ''Caution: Do no lower the cup too much, or the rotating blending rod could spray above the metal shield.''
 +
: 8. Release foot from blender pedal.
 +
Serving:
 +
: 9. Remove metal shield from cup.
 +
: 10. Get a spoon.
 +
: 11. Serve.
 +
 
 +
 
 +
: 12. Rinse metal shield before next use.
 +
</small>
  
  
Line 37: Line 79:
 
It is a good idea to group steps into logical, labeled stages, rather than using one long list with no groupings.  This will help the reader both follow and better understand the process.
 
It is a good idea to group steps into logical, labeled stages, rather than using one long list with no groupings.  This will help the reader both follow and better understand the process.
  
=====Example: (Good)=====
+
Below are some instructions for preparing a Blizzard/McFlurry.  If there were no task headers, imagine how difficult it would be to refer to the instructions while executing them.  Again, any cue that can help the reader quickly find where they currently are is a good thing.
: Task 1:
+
:# step 1
+
:# step 2
+
: Task 2:
+
:# step 3
+
:# step 4
+
 
+
=====Example: (Bad)=====
+
:# step 1
+
:# step 2
+
:# step 3
+
:# step 4
+
  
  
 
===Guideline 5: Place One Action in a Step===
 
===Guideline 5: Place One Action in a Step===
Text!
+
For exactly the same reasons that you shouldn't put several steps in a lengthy paragraph, you should also avoid putting multiple actions in one step.  Unless two actions are to be done at the same time, each step should have no more than one action.  Readers shouldn't have to read through lengthy steps to figure out which part of the step they're in.
 +
 
  
 
===Guideline 6: Lead off Each Action Step with a Verb===
 
===Guideline 6: Lead off Each Action Step with a Verb===
Text!
+
Starting each step with a verb lets the reader immediately know what action is required in the step.
 +
 
  
 
===Guideline 7: Remove Extra Information from the Step===
 
===Guideline 7: Remove Extra Information from the Step===

Revision as of 19:54, 8 April 2008

COMP3040 > Common Components


Introduction

The intro text.






...by students

dshjfhdskjfshd!


Guidelines for Instructions

The text covers several guidelines for writing good instructions. Here we will emphasize how each guideline can assist the reader and avoid frustration.


An Example

Below are example instructions that employ nearly all of the guidelines; this example will be referred to throughout the page.

These instructions detail the preparation a Blizzard/McFlurry (or other similar ice cream or frozen yogurt treat) using given fast-food machinery, for the purpose of serving a customer. The presumed audience is someone completely new to the process of making this delicious item, who has little or no outside assistance at the moment. As such, the instructions need to be thorough, as well as easy to understand and follow. Note: These instructions assume the reader already has the required machinery and materials at hand.


Making a Blizzard


Intro.

Materials needed:

  • material 1
  • material 2
  • material 3


1. Fit metal shield on to top of a fresh cup.

Filling the cup:

2. Fill cup half-way with ice cream.
3. Add toppings.
4. Fill cup to the top with ice cream
Note: It is ok if the ice cream is filled above the cup's rim.

Blending:

5. Position cup underneath blender so that the rod is inside the ice cream.
6. Simultaneously:
  • Gently push down blender pedal with your foot.
  • Slowly move cup up/down to mix the entire contents.
7. Lower cup so the rod is no longer in the ice cream, keeping pressure on the foot pedal.
Caution: Do no lower the cup too much, or the rotating blending rod could spray above the metal shield.
8. Release foot from blender pedal.

Serving:

9. Remove metal shield from cup.
10. Get a spoon.
11. Serve.


12. Rinse metal shield before next use.


Guideline 1: Select the Correct Technical Level

Know your audience! You'll want to write your instructions in such a way that your least technical readers can understand them. Use language that all readers can understand, defining terms beforehand as needed.


Guideline 2: Provide Introductory Information

Providing proper introductory information is key. Instructions should follow the ABC format (Abstract/Body/Conclusion).

An introduction should include:

  • a purpose statement (What will following these instruction accomplish?)
  • a summary of the main steps (Briefly describe what following the steps will involve.)
  • a list of materials needed (Whether you use an illustration, a textual list, or reference to a list, readers need to know beforehand whether they have all the proper tools.)

Other introductory information that may help readers:

  • Helpful pointers
  • Definitions of terms
  • Theory of how something works
  • Dangers, warnings, cautions, or notes that apply to all steps


Guideline 3: Use Numbered Lists in the Body

Instructions are much easier to read as lists of steps, rather than longer paragraphs. Keep in mind that readers may frequently switch their attention between your instructions and the actual task. Using numbered lists, readers can always know what step they're at.


Guideline 4: Group Steps under Task Headings

It is a good idea to group steps into logical, labeled stages, rather than using one long list with no groupings. This will help the reader both follow and better understand the process.

Below are some instructions for preparing a Blizzard/McFlurry. If there were no task headers, imagine how difficult it would be to refer to the instructions while executing them. Again, any cue that can help the reader quickly find where they currently are is a good thing.


Guideline 5: Place One Action in a Step

For exactly the same reasons that you shouldn't put several steps in a lengthy paragraph, you should also avoid putting multiple actions in one step. Unless two actions are to be done at the same time, each step should have no more than one action. Readers shouldn't have to read through lengthy steps to figure out which part of the step they're in.


Guideline 6: Lead off Each Action Step with a Verb

Starting each step with a verb lets the reader immediately know what action is required in the step.


Guideline 7: Remove Extra Information from the Step

Text!

Guideline 8: Use Bullets or Letters for Emphasis

Text!

Guideline 9: Emphasize Cautions, Warnings, and Dangers

Text!

Guideline 10: Keep a Simple Style

Text!

Guideline 11: Use Graphics

Text!

Guideline 12: Test Your Instructions

Text!