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.
Use consistent formatting
From the course: Technical Writing: Quick Start Guides
Use consistent formatting
- You may be the writer of your quick start guide but that's not your only role. You're the formatter of your guide too. So when it comes to the appearance of your guide, you're in charge. Being the formatter may not seem like a big responsibility, but it is. All the choices you make about how to format your guide, fonts, colors, columns, whether the bullets will be round or square, all those choices greatly affect how easy to read and how useful your guide will be. When it comes to formatting, the most important thing to remember is that formatting conveys meaning. It's not just decorative, so you don't make one bulleted item orange while all the others are black just because you feel like it. If you change the color of an item, it should be to convey additional meaning. Here's an example from a quick start guide on setting up an external hard drive. Can you tell why the writer made the third bullet blue? It's blue because it's a warning. It's advice about what not to do. I'm betting…
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)
-
-