Developing Quality Technical Information: A Handbook for Writers and Editors

by Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez

The #1 guide to excellence in documentation--now completely updated! A systematic, proven approach to creating great documentation Thoroughly revised and updated More practical examples More coverage of topic-based information, search, and internationalization Direct from IBM's own documentation experts, this is the definitive guide to developing outstanding technical documentation--for the Web and for print. Using extensive before-and-after examples, illustrations, and checklists, the authors show exactly how to create documentation that's easy to find, understand, and use. This edition includes extensive new coverage of topic-based information, simplifying search and retrievability, internationalization, visual effectiveness, and much more. Coverage includes: Focusing on the tasks and topics users care about most Saying more with fewer words Using organization and other means to deliver faster access to information Presenting information in more visually inviting ways Improving the effectiveness of your review process Learning from example: sample text, screen captures, illustrations, tables, and much more Whether you're a writer, editor, designer, or reviewer, if you want to create great documentation, this book shows you how!

Genres: Reference, Writing, Nonfiction, Professional Development, Business

463 pages, ebook

First published October 1, 1997

Reviews

[Wendy · Rating 3 out of 5]

One of the best books I've come across at addressing the skills and practices that are particular to good technical writing as opposed to good writing in general. Some of the material will seem a bit obvious to the experienced technical writer, but the many examples will be valuable to writers at all levels.

[Robin · Rating 4 out of 5]

If you are new to technical writing, it would be hard to find a better primer than this one. Brimming with realistic examples and strong opinions (perhaps occasionally too strong?) about exactly what your content and style rules should be, this book crammed a lot of best practices into 541 pages. Even if "in real life" I'll never be able to apply all this great advice and still make my deadlines, I'm getting closer than I otherwise would have.

The book design and layout made me twitch, but that's just my pre-tech writing publishing maven talking, and I have to learn to ignore her now.

[Joanne Cheek · Rating 1 out of 5]

Bored me to tears. DNF

[Blair · Rating 4 out of 5]

I like this book on several levels. This book is the standard for what it is teaches for developing good quality documentation: it is easy to use as a reference, with headings and a table of contents that many other technical books would do well to emulate. It clearly explains how to write or techniques to follow to help improve your writing quality, along with the why. It's recommendations are immediately useful.

If I had to choose only one book to refer to on my bookshelf, I'd toss aside my style guides, and keep this nearby.

[Ember DeBoer · Rating 4 out of 5]

Though I've read an earlier edition of this book, I recently evaluated this one as a replacement to the textbook I'm currently using in my technical writing class. I'm partial to this particular IBM veteran's work. :)

[Evelyn · Rating 5 out of 5]

Great reference and tutorial for beginning tech writers to seasoned veterans. My team of senior writers with over 15 years; experience found it as valuable as my junior writers.

[Peter Anderson · Rating 3 out of 5]

A good book for pedants like me :-)

[Sarah R. · Rating 5 out of 5]

This is a really good reference book for technical writers. We have used it to build out our review checklists and to get cleaner and clearer with our docs.