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.
Address your user directly
From the course: Technical Writing: Quick Start Guides
Address your user directly
- There's an old saying in the technical writing community that goes something like this users never refer to themselves as users. Like lots of old sayings, this one is very wise. Developers may refer to the people who will use their products as users, and the marketing team may call them customers. You may have been referring to future readers of your Quick-Start Guide as users, too, but that's not how they refer to themselves. So when you write your Quick-Start Guide, you'll need to refer to the people who are using it in terms they will recognize and respond to. You want the readers to see themselves in the guide and to recognize it's there to help them. Here are two reliable ways to refer to your users in your guide. Use second person pronouns you, your or yours. For example, instead of writing "The user should click Protected Account to view "all the status information on each registrant." You should use the pronoun you, write this instead. "You should click Protected Account to…
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)
-
-