Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Writing Documentation that Matters


Published on

Have you ever wondered if people read the documentation you produce? This workshop will address specific ways you can determine the needs of your audience and then write documentation that is more user focused and better connects with your intended users. Each attendee would discuss the documentation he or she produces, concerns he or she may have, and ways he or she can write better documentation.

Published in: Education
  • Be the first to comment

  • Be the first to like this

Writing Documentation that Matters

  1. 1. Writing Documentation That Matters Writing to Address the Specific Needs of Your Audience Answer these questions as the first step in any writing/documentation task. Why am I writing this? What do I want the reader to do (or be able to do)? Who exactly is my reader? Do I have more than one? What is the reader’s role? Decision-maker? Influencer? Implementer? Other? What does the reader already knowabout the subject? Does the reader have any preconceived notions about the documentation? What’s in it for the reader? Why should the reader even bother reading? Howwill the reader use this document? One-time read? Or a frequently used reference material? Good writers make the reader feel smart—are you making the reader feel smart? What is ultimately the best way to connect with your audience?