Duration: 15 min.
In this podcast, Joe Sokohl explains how to create user-centered documentation by contacting, observing, and interviewing users to gather information about what types of information they use and the help deliverables they actually want.
In his experience, Joe found that almost no one used the user manual, but instead wanted quick information for specific tasks. The users hated stand-up training with PowerPoint slides (what the execs thought users needed), and instead wanted hands-on experience with the real system.
Creating user-centered documention requires technical writers to break the standard (and ridiculous) rule of not contacting the user, to get out of their shells and interact and interview others, and to often challenge standards and assumptions from executives. It may be hard, but doing so is essential, because if you end up creating the wrong deliverables, all your efforts to create help may be irrelevant and useless.
In the podcast, Joe recommends a number of books:
Get new posts delivered straight to your inbox.
I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here. You can also contact me with questions.