The User Manual Manual : How to Research, Write, Test, Edit & Produce a Software Manual (Untechnical Press Books for Writers) [Paperback]

Michael Bremer (Author)

Book Description

Series: Untechnical Press Books for Writers | Publication Date: November 20, 1999

The User Manual Manual is a master's course on software manuals. It describes the grammar, style, techniques and tricks needed to write a manual the gets read. It explains how to understand and target readers, technicaly inclined or not--even if they're kids. Plus, it covers special topics including: dealing with rush projects, preparing for internationalization, and handling projects with multiple writers, multiple platforms and multiple bosses. The User Manual Manual is a guided tour through the entire process of creating a user manual from initial concept through writing, testing, editing and production to postmortem. It contains sample documents, worksheets and checklists to help writers work smarter and faster.

Editorial Reviews

About the Author

For nearly 10 years as writer, editor, writing manager and Director of Creative Services at Maxis software (the SimCity(R) company), Michael Bremer developed proven techniques to write and produce readable, understandable, and even enjoyable technical writing. He is now an independent author and consultant, specializing in communicating complex technical subjects to a non-technical (consumer) audience.

Product Details

• Paperback: 314 pages
• Publisher: UnTechnical Press (November 20, 1999)
• Language: English
• ISBN-10: 0966994914
• ISBN-13: 978-0966994919
• Product Dimensions: 10 x 7 x 0.8 inches
• Shipping Weight: 1.6 pounds
• Average Customer Review: 4.4 out of 5 stars  See all reviews (11 customer reviews)
• Amazon Best Sellers Rank: #510,188 in Books (See Top 100 in Books)

More About the Author

Discover books, learn about writers, read author blogs, and more.

Customer Reviews

Most Helpful Customer Reviews

50 of 50 people found the following review helpful:

5.0 out of 5 stars Great guide to writing for the 'untechnical', January 23, 2000

By 

John C. Hewitt - See all my reviews

This review is from: The User Manual Manual : How to Research, Write, Test, Edit & Produce a Software Manual (Untechnical Press Books for Writers) (Paperback)

The User Manual Manual is Michael Bremer's follow-up to Untechnical Writing. Unlike Untechnical Writing, this book is focused solely on the development process for a software manual. He describes and demonstrates how to create a software manual from the planning phase through publication.

Bremer takes the reader through the entire process, from planning to writing and editing to final production. Unlike many books on technical writing, The User Manual Manual assumes that you can write. Bremer doesn't waste a lot of time going over grammar lessons. The focus of this book is more on processes such content editing and testing. Also, Bremer is focused solely on the software manual. He includes instructions on writing specifically for that genre, such as how to write quick-start guides, online help and readme documents. Bremer is also careful to give plenty of examples throughout the book so that you can see his advice in action.

This is an excellent guide to the process of writing software documentation. Any technical writer can benefit from reading it. It is especially useful for those just entering the field and for those who are taking on leadership roles in their documentation projects

36 of 38 people found the following review helpful:

5.0 out of 5 stars If you're going to write users' manuals, read this first., March 27, 2001

By 

AndKarena "andkarena" (California) - See all my reviews

This review is from: The User Manual Manual : How to Research, Write, Test, Edit & Produce a Software Manual (Untechnical Press Books for Writers) (Paperback)

I got this book last year just before I was called for an interview for the position I hold as Senior Technical Writer for a small software firm. I read it twice through, and paid close attention to the examples. With the help of what I learned I got the job, and have been successfully writing all our documentation since. With the help of this book I was able to capitalize on my writing skills and education, and make the transition smoothly into technical writing. It gave me a step-by-step guide with examples to planning and creating the type of publications I would be expected to produce, and outlined all the processes thoroughly. I have reccommended this book to several of my colleagues.

28 of 31 people found the following review helpful:

5.0 out of 5 stars Finally, a truly accessible guide for manual writers, September 30, 2000

By 

Gina Ryerson (USA) - See all my reviews

This review is from: The User Manual Manual : How to Research, Write, Test, Edit & Produce a Software Manual (Untechnical Press Books for Writers) (Paperback)

The User Manual Manual: How to Research, Write, Test, Edit and Produce
a Software Manual by Michael Bremer

I'm learning to write technical
manuals on-the-job. So I was pleasantly surprised to stumble on
Michael Bremer's The User Manual Manual. It's the most
straightforward, demystifying book on this topic I've seen, by far.
The only exceptions are a few well-written actual manuals, which were
the only worthwhile working guides I had before finding this book.
But they don't explain how to write manuals. Otherwise, I bought 3
books on "how to write tech manuals" by other authors, but
The User Manual Manual is the only one I would bother using. The rest
were too academic, dry, dense, lengthy or flowery.

Michael Bremer
takes care of the tech writer, walking you through every step of
manual planning and writing. His approach reminds me of a friend I'm lucky to have, a computer instructor at my local City College who is
very popular with his students. He originally taught me how to use my
first computer. Then there is my geeky friend who tutored me on how
to use multiple programs to run my business. Now I'm an independent
tech writer, but not part of a big team like most manual writers. I'm
mostly on my own, and now The User Manual Manual will be my bridge
from learning software to writing tech manuals.

It's like Michael
Bremer is standing at my desk and helping, being friendly and patient.
None of my questions are dumb questions. And I'm full of
questions!

Thank You, Michael Bremer.

Gina Ryerson