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