Developing Quality Technical Information
A Handbook for Writers and Editors
Nonfiction, Science & Nature, Technology, Technical Writing
| Author: | Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, Elizabeth Wilde | ISBN: | 9780137034789 |
| Publisher: | Pearson Education | Publication: | April 6, 2004 |
| Imprint: | IBM Press | Language: | English |
| Author: | Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, Elizabeth Wilde |
| ISBN: | 9780137034789 |
| Publisher: | Pearson Education |
| Publication: | April 6, 2004 |
| Imprint: | IBM Press |
| Language: | English |
"The examples are excellent--right on target and easy to understand and adapt. Even those who don't adopt the entire procedure can profit from the parts, but the greatest value will flow to those who adopt the whole." --Carolyn Mulford, senior writer and editor of Writing That Works
"This is also a book that students can keep for their professional libraries because it will increase in its value to them after they leave class and face real life experiences on the job. It is plain enough for them to understand while they are learning, and at the same time comprehensive enough to support them as professionals." --Elizabeth Boling, Instructional Systems Technology, Indiana University
"It practices what it preaches. Its guidelines are understandable and appropriate; its examples clear. It contains exactly what writers and editors need to know. It is the book that I would have written." --Cynthia E. Spellman, Unisys
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!
"The examples are excellent--right on target and easy to understand and adapt. Even those who don't adopt the entire procedure can profit from the parts, but the greatest value will flow to those who adopt the whole." --Carolyn Mulford, senior writer and editor of Writing That Works
"This is also a book that students can keep for their professional libraries because it will increase in its value to them after they leave class and face real life experiences on the job. It is plain enough for them to understand while they are learning, and at the same time comprehensive enough to support them as professionals." --Elizabeth Boling, Instructional Systems Technology, Indiana University
"It practices what it preaches. Its guidelines are understandable and appropriate; its examples clear. It contains exactly what writers and editors need to know. It is the book that I would have written." --Cynthia E. Spellman, Unisys
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!
