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.

Base your quickstart guide on input from users

Base your quickstart guide on input from users

From the course: Technical Writing: Quick Start Guides

Start my 1-month free trial

Base your quickstart guide on input from users

- When developing your quick start guide, you may be in a room all by yourself, but in the most important way you are far from alone. Your users should be with you in spirit at all times. You're writing your guide to answer their questions and meet their needs so you shouldn't wonder about what type of help they need. You should do your research and be sure you know what topics they need you to cover in the guide. Here are four steps you can take to get real intel on what to put in your guide. Review the most used knowledge base articles or FAQs at your site. Of all the self-service content your company offers, find out which items are viewed the most. Track what's being discussed in your user community or forum. This can be a source of massive amounts of information. Because users often vent to each other in an online community, you'll get the no holds barred version of their questions. They might post this question. "Book Publishing Tool won't let me upload images. "Whyyyyyyy???"…

Contents