This is a method tested reference guide (developed over 10 yrs. at IBM's technical Info Labs) for technical writers and editors in communication and engineering companies. It features extensive examples, illustrations and before and after excerpts from real technical information to help the reader/user become a very competent writer or editor.
79032-9
The #1 guide to excellence in documentation!
Create documentation that even the most demanding users will appreciate!
All you need to deliver top-quality technical information -- in print, online, and on the Web!
- Extensive, practical before-and-after examples
- Sample windows, illustrations, excerpts, tables, checklists, and more
- Smarter ways to use visuals
- Based on the experience of professionals at an IBM software laboratory for over 10 years
- For every writer, editor, designer, and reviewer of technical information
Straight from IBM's own software documentation experts, this is the first practical guide to developing excellent technical information.
From start to finish, you'll learn how to create documentation that's easy for users to find, understand, and use.
Discover how to make sure your documentation focuses on the tasks and topics users care about. Learn style points and organization techniques that help users access information quickly -- and use it effectively. See how to use graphics and other visual elements to deliver useful information in inviting ways. Walk through the review process, and learn ways to add the most value using minimal words.
Whether you're a writer, editor, designer, or reviewer, if you want to create great documentation, this book shows you how!
“Developing Quality Technical Information is unequaled in the field today as a comprehensive textbook on how to do technical communications right. Every technical communicator around the world can surely apply this model to their information; those that do so systematically will surely see an improvement in the quality of their deliverables." Lori Fisher, Manager, Data Management User Technology, IBM; Instructor, University of California Extension Santa Cruz
"The writers have done an excellent job of keeping the editorial advice simple and clear enough for technical writers who didn't major in English or journalism. The book should make a very good technical writing and editing text in universities, but I think it will be even more valuable for experienced writers, editors, and managers concerned with raising the quality of their publishing programs." Carolyn Mulford, Freelance Writer and Editor Instructor, Georgetown University Continuing Education
