From the course: Technical Writing: Quick Start Guides
Unlock the full course today
Join today to access over 22,600 courses taught by industry experts or purchase this course individually.
Solution: Revise a quickstart guide
From the course: Technical Writing: Quick Start Guides
Solution: Revise a quickstart guide
- Okay, so you've taken a crack at it. Let's compare notes. Here are my revisions to the instructions from the local school district's quick start guide to budgeting. You can find them in the exercise files. Your edits might be different from mine, but as long as you use the writing techniques below I'm sure you improved the instructions. You'll see I addressed the reader directly using your, or the imperative form. See here that I also added headings to group the instructions. Another good technique that you see in this handout is to move the supplementary information like notes to before the actual instruction. Finally, like we said before, we begin each step with a verb. How did you do? No doubt there's several ways to improve these instructions, but they can't be left as they were. A confusing mish-mash of overview about the law, and advice about the specific pages on the form. That's just not a quick start guide to anything.
Practice while you learn with exercise files
Download the files the instructor uses to teach the course. Follow along and learn by watching, listening and practicing.
Contents
-
-
-
-
-
(Locked)
Address your user directly3m
-
(Locked)
Identify the overall purpose of the guide by explaining the outcome4m 4s
-
(Locked)
Write clear headings4m 1s
-
(Locked)
Begin each step with a verb3m 36s
-
(Locked)
Provide context or notes before steps, not within them3m 1s
-
Use plain language4m 37s
-
(Locked)
Use consistent formatting3m 52s
-
(Locked)
Challenge: Revise a quickstart guide56s
-
(Locked)
Solution: Revise a quickstart guide1m 5s
-
(Locked)
-
-