How To Write Usable User Documentation : Second Edition

Rating:
Summary: Mandatory reading
Review: 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.

Rating:
Summary: A system for saving your sanity
Review: This book is all about applying engineering principles to document production. Basically, you start with questions like: "Who is this documentation for?" and "What is the document's purpose?". You then plan your document as a series of modules. By creating a title, abstract and outline for each module, you have a basis to discuss, test, plan and assign sections of the document. I've seen a few technical books follow the layout guidelines presented in this book, and the results are usable and readable. The procedures will take your team some getting used to -- but the results are worth it. My documentation projects that were overwhelming became manageable.

Rating:
Summary: A system for saving your sanity
Review: This book is all about applying engineering principles to document production. Basically, you start with questions like: "Who is this documentation for?" and "What is the document's purpose?". You then plan your document as a series of modules. By creating a title, abstract and outline for each module, you have a basis to discuss, test, plan and assign sections of the document. I've seen a few technical books follow the layout guidelines presented in this book, and the results are usable and readable. The procedures will take your team some getting used to -- but the results are worth it. My documentation projects that were overwhelming became manageable.

Rating:
Summary: Planning steps key to good documents
Review: 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.

Rating:
Summary: Planning steps key to good documents
Review: 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.