Difference between revisions of "Instructions"
Line 4: | Line 4: | ||
|...by students= | |...by students= | ||
dshjfhdskjfshd! | dshjfhdskjfshd! | ||
− | }} | + | |Chapter_TOC=[[Common Components]]}} |
Line 31: | Line 31: | ||
===Guideline 3: Use Numbered Lists in the Body=== | ===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=== | ===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. | |
+ | |||
+ | =====Example: (Good)===== | ||
+ | : 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=== |
Revision as of 14:41, 8 April 2008
Introduction
The intro text.
Contents
|
...by studentsdshjfhdskjfshd!
Guidelines for InstructionsText!
Guideline 1: Select the Correct Technical LevelKnow 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 InformationProviding proper introductory information is key. Instructions should follow the ABC format (Abstract/Body/Conclusion). An introduction should include:
Other introductory information that may help readers:
Guideline 3: Use Numbered Lists in the BodyInstructions 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 HeadingsIt 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)
Example: (Bad)
Guideline 5: Place One Action in a StepText! Guideline 6: Lead off Each Action Step with a VerbText! Guideline 7: Remove Extra Information from the StepText! Guideline 8: Use Bullets or Letters for EmphasisText! Guideline 9: Emphasize Cautions, Warnings, and DangersText! Guideline 10: Keep a Simple StyleText! Guideline 11: Use GraphicsText! Guideline 12: Test Your InstructionsText! |