Page 1
WritingUser-Friendly Instructions
Page 2
You’ll have 4 sets of readings
• World Wide Web site (click here for access)
• an instruction checklist (below)
Page 3
You’ll have 4 sets of readings
• 3 sets of student-written instructions (see the starting page for lesson 7)
• Microsoft Word Helpful Hints (see the starting page for
the Instruction lesson)
Page 4
Instruction Checklist
Page 5
Instruction Checklist
• Use this list to help you write effective instructions.
• This list also contains my grading criteria.
Page 6
Title• Clear
• Precise
• Limiting
Page 7
Vague title: "Changing a Flat Tire"
Precise title: "Changing a Flat Tire on a Toyota Corolla, 1994-1998"
Page 8
Introduction• states your purpose
• establishes the parameters--what the instructions will or will not include
Page 9
Introduction• explains the benefits to
the user--a sales pitch to use the instructions
• previews upcoming information
Page 10
Introduction• estimates the time
needed to complete the steps
• informs the reader of any special circumstances
Page 11
Example introduction• Find the introduction
• Find all of the parts of the introduction
Page 12
List of materials / tools• contains some
introductory text
• uses a list format
Page 13
Steps• Include only one verb per
step
• Every sentence within your steps should have a number or a bullet
Page 14
Steps• Number each step--every
sentence that is giving a command
• Bullet all informational sentences--every sentence that is not giving a command
Page 15
Steps• Include all steps--don't
leave any out
• List all steps in chronological order
Page 16
Steps• Place the most important
information first within the step
• Make all instructions thorough
Page 17
Steps• Use examples where
needed
Page 18
Steps• Group related
instructions into subgroups with headings–each subgroup should
begin with #1
Page 19
Steps• Show the relationships
between steps in cases of danger or intricate operations
Page 20
Warnings• Warn of danger to
persons or property
Page 21
Warnings• place them immediately
before the step to which the warning relates
Page 22
Warnings• Make them visually
prominent, with borders, colors, symbols, etc.
Page 23
Warnings• include a thorough
explanation of the warning
Page 24
Cautions• state precautions to
avoid injuries, problems, etc.
Page 25
Cautions• place them immediately
before the step
Page 26
Cautions• are visually prominent
with borders, colors, symbols, etc.
Page 27
Cautions• include a thorough
explanation
Page 28
Notes and / or Hints• state helpful information
Page 29
Notes and / or Hints• place them appropriately
–sometimes before a step
–sometimes after a step
Page 30
Notes and / or Hints• make them visually
prominent
Page 31
Conclusion• provide a sense of
closure, reassurance, congratulations
Page 32
Conclusion• describe the results
Page 33
Conclusion• make it a paragraph--not
another step
Page 34
Conclusion• may explain the
maintenance of the product
Page 35
Accurate audience analysis
• appropriate language level/specialized terms
Page 36
Accurate audience analysis• appropriate examples
used
Page 37
Accurate audience analysis• ample detail given
Page 38
Accurate audience analysis• adequate background
given
Page 39
Accurate audience analysis• determine how the
readers will use this document
Page 40
Accurate audience analysis• determine the actual
setting of the users
Page 41
Effective presentation
• Audience
• Setting
Page 42
Size, Shape, & Form
• 8.5" x 11" • poster• Video (turn in the script, too)• website• anything your skill and
creativity tell you would be effective
Page 43
$$$$$$ Expense? $$$$$$
• Laminated?
• Enlargements?
• Photographs?
Sticky-note policySticky-note policy
Page 44
Effective format• single space within steps
• double space between steps
Page 45
Effective format• do not continue a step or
an illustration onto a new page–no widows or orphans
Page 46
Effective format• number the steps
Page 47
Effective format• each numbered step
should contain only one sentence
Page 48
Effective format• bulleted informational
sentences may contain more than one sentence, but only if they contain one main idea
Page 49
Effective format• inviting, persuasive,
user-friendly appearance
Page 50
Effective format• use effective white
space: keep it uncluttered
Page 51
Effective format• access should be easy in,
easy out
Page 52
Headings• use headings to divide
major steps from sub-steps
• use left hanging headings
Page 53
Headings• use specific words for
headings
• use verb-based headings
Page 54
Fonts• Attractive, readable font
for text–nothing distracting or hard to read
–no courier
Page 55
Fonts• More creative font for
headings–Free fonts on the Internet
–Google: “free fonts”
Page 56
Fonts
•Bell Bottom•JetSetSSK, 123•Paper Bag
Page 57
Style• clear language
• simple language
Page 58
Style• Articles used
–the, an, a
–If you can't tell where you need to use an article, read your instructions aloud. If you sound like a robot, then add the article.
Page 59
Style• imperative mood
–a command•Turn on the switch
Page 60
Style• maintain nomenclature
–always refer to the same item by the same name
Page 61
Style• Concise
• Active voice
• Precise language
• Unambiguous language
Page 62
Sentence Structure• short, direct sentences
• similar sentence structure
• strong verbs, usually at the beginning of sentences
Page 63
Illustrations
• Useful
• Placed adjacent to the instruction
Page 64
Illustrations• referred to in the text
–“Place the bricks side by side, as shown in Figure 14. Placing the Bricks”
Page 65
Illustrations• Accurate
Page 66
Illustrations• numbered and labeled as
an illustration–Figure 1. Sandblasting
Page 67
Illustrations• label the parts of the
visual
Page 68
Illustrations• note any differences
between visual and reality
Page 69
Illustrations• reinforce visually the
verbal information
Page 70
Illustrations• used at each opportunity
Page 71
Illustrations• add color
Page 72
Illustrations• line drawings preferable
to fuzzy photographs
Page 73
User testing• test your instructions on
the actual users
• revise problem areas