Get full access to Developing Quality Technical Information: A Handbook for Writers and Editors, Third Edition and 60K+ other titles, with free 10-day trial of O'Reilly.
There's also live online events, interactive content, certification prep materials, and more.
About the authors
Part 1. Introduction
Chapter 1. Technical information continues to evolve
Progressive disclosure of information
The technical writer’s role today
Redefining quality technical information
Chapter 2. Developing quality technical information
Preparing to write: understanding users, goals, and product tasks
Writing and rewriting
Reviewing, testing, and evaluating technical information
Part 2. Easy to use
Chapter 3. Task orientation
Write for the intended audience
Present information from the users’ point of view
Focus on users’ goals
Identify tasks that support users’ goals
Write user-oriented task topics, not function-oriented task topics
Avoid an unnecessary focus on product ...
Get Developing Quality Technical Information: A Handbook for Writers and Editors, Third Edition now with the O’Reilly learning platform.
O’Reilly members experience live online training, plus books, videos, and digital content from nearly 200 publishers.
Get Mark Richards’s Software Architecture Patterns ebook to better understand how to design components—and how they should interact.