How to Write Usable User Documentation: Second Edition

by Edmond H. Weiss

Book Overview

This popular handbook presents a step-by-step method for clearly explaining a product, system, or procedure. The easy-to-follow text--packed with examples and illustrations--explains the unique demands of this form of writing and shows how to set up the best user model. The book covers developing a modular outline and storyboard, generating the draft, revising, developing a formal usability test, and supporting and updating user documentation. Also...

• Format: Paperback
• Language: English
• ISBN: 0897746392
• ISBN13: 9780897746397
• Release Date: June 1991
• Publisher: Greenwood
• Length: 280 Pages
• Weight: 1.75 lbs.
• Dimensions: 0.7" x 8.4" x 10.9"

Customer Reviews

Great book

This bok provides allot of examples and leads by that making it easy to understand and follow.

Solid, Spartan Book

Not a lot of waste involved with this book. The reviews here are right on. This book shows how to do tech writing by example. It also gives reliable guidelines for doumentation planning. If you are a starting tech writer reading this book is what you need to do solid instructions writing. it does not really cover documentation technologies, but after reading this book you should be able to choose technologies that enable the type of doc writing and concepts in this book.

Planning steps key to good documents

Weiss covers all the basics: not just how to write, but how to plan documentation so that it benefits the user, the technical contributor and the person responsible for getting the documentation to users. The ideas are practical, sensible and well formed. Examples and exhibits (graphics) provide real-life models. The writing is clear, concise and a prime example of the author's premise. The typography and layout do the same. This is just what my boss (an engineer) and I (a tech writer) have been looking for: ways to upgrade our documentation process and our documents. The structure suits us wonderfully and is easier to apply than I thought possible.

Mandatory reading

This book clearly and succinctly lays out the objectives and the methods of technical writing. After 15 years in the business I still haven't seen another book that comes even close to this one.

Excellent book!

Excellent book! I used the book for a technical communications course. I initially had reservations about the book but I became a 'convert' after reading it and following the author's approach. The author recommends a modular approach to creating user documents. His book contains specific information on how to analyze the audience, create a storyboard, and present the material, etc