The #1 Guide to Excellence in Technical Communication—Fully Updated for Embedded Assistance, Mobile, Search, Multimedia, and More
Direct from IBM’s own content design experts, this guide shows you how to design product interfaces and technical information that always place users front and center. This edition has been fully revised to help you consistently deliver the right content at the right time.
You’ll master today’s best practices to apply nine essential characteristics of high-quality technical information: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness.
Advocating for users throughout the entire product development process
Delivering information in an ordered manner by following progressive disclosure techniques
Optimizing content so that users can find it from anywhere
Streamlining information for mobile delivery
Helping users right where they are
Whether you’re a writer, editor, information architect, user experience professional, or reviewer, this book shows you how to create great technical information, from the product design to the user interface, topics, and other media.
Thoroughly revised and updated
Extensive new coverage of self-documenting interfaces and embedded assistance
Updated practical guidelines and checklists
Hundreds of new examples
Most Helpful Customer Reviews
As an enterprise and software architect the one thing I hate most about my job is documentation, yet the importance of doing documentation on sizable projects is what I find myself preaching about the most.
One reason I understand the importance of documentation is that I came from an electronic engineering background. As an electronic engineer 93% - 97% of my time was consumed doing proof of concepts and documentation. Almost all of that time was documentation.
It was just my luck that my boss was an English grammar teacher before moving into engineering. My documents came back very bloody. He used a red pen to mark up my documents. It took me 2 years, and a whole lot of tongue biting, but I started getting papers through him without a red mark. I still remember the first one. I walked outside to where the smokers took their breaks and let out a screaming "YES, Finally!!!"
I have been without my grammar teaching boss for over 18 years now, and I am...
I am a technical writer and editor with eight years of experience, and I regret that I did not read this book when I first started my career. When people ask me about getting started in technical documentation, I recommend this book to them. The main sections of the book provide guidelines on writing documentation that is easy to use, easy to understand, and easy to find. The book definitely follows these concepts, which helps when I reference it for developing content, editing content, or determining the best style guidelines for the documentation teams that I work with.
This book has been so invaluable that I have a paperback at home, a paperback in the office, and a Kindle edition that I can reference from my mobile devices. It is full of so much useful information, I reread sections periodically to refresh myself on the guidelines in that section. Whether you are new or experienced in technical documentation, I highly recommend this book to you.
I've been a technical editor for many decades and I always tell anyone who asks that this is the best reference for anyone who writes or reviews technical content because it is.
I've used this book for my editing since version 2 and I'm a believer that if you use this book, your tech writing will improve and your understanding of the roles of the different reviewers will be much clearer.
Buy it, read it, use it! Just do it!
The authorised South African distributor of this product is under no obligation to honour the manufacture's guarantees/warranties or to provide after-sales service.
Please note that this item is imported from the USA, and is designed to be used in the USA. In addition, if the unit is powered it will come with a US plug and an adapter/transformer may be required. Please click here for more information on power requirements, or check with us if you are unsure or need any assistance!
Please also note that certain items cannot be imported, these include Alcohol, Animals, Batteries, Flammable Materials, Currency, Food, Furs, Chemicals, Explosives, Medications, Plants, Seeds, Supplements, Pressurized Cans, Tactical Equipment, Vitamins, Weaponry and Weaponry Accessories. In these cases, the item and information is displayed for reference purposes only. If you are not sure if we are permitted to bring an item, please send us an e-mail with a link to the item to confirm.
Please also ensure that you are ordering the correct item for your particular application as returns to the USA are costly. Product reviews are also provided for most of our items, which can give you a good idea for possible things to look out for and the quality of the item. By clicking Add to Cart, you are confirming that the item is correct and you accept the conditions listed here.