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

by Michael Bremer

The User Manual Manual is a master's course on creating software manuals. Written for writers, managers and producers, it describes the grammar, style, techniques and tricks needed to write a manual... This description may be from another edition of this product.

• Format: Paperback
• Language: English
• ISBN: 0966994914
• ISBN13: 9780966994919
• Release Date: November 1999
• Publisher: UnTechnical Press
• Length: 314 Pages
• Weight: 1.50 lbs.
• Dimensions: 0.8" x 7.0" x 10.0"

Customer Reviews

Great for the novice, fair for the experienced

I had this book on my wish list for at least a year and received it at Christmas. I have been writing user's manuals for a few years now and I was expecting to get fresh ideas from this book. I read it all the way through to only say to myself, "well that was interesting but how much did I get out of it?" I realized that I already knew most of what is in the book. So, am I disappointed? No. Bremer has done a great job of explaining the process of writing good user manuals. It is well organized and gives good examples. It reminded me of what is important in a good manual. The one exception that I have though is, Bremer often writes about the technical writer who writes the text and then turns the project over to a designer to format the manual. These days, it is the writer who often does the writing and formatting. I do not know too many writers who does otherwise. This book is a must for anyone who has not written a software manual. For the people who have written successful manuals, they will not get a lot out of it.

If you're going to write users' manuals, read this first.

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.

Finally, a truly accessible guide for manual writers

The User Manual Manual: How to Research, Write, Test, Edit and Producea Software Manual by Michael BremerI'm learning to write technicalmanuals on-the-job. So I was pleasantly surprised to stumble onMichael Bremer's The User Manual Manual. It's the moststraightforward, demystifying book on this topic I've seen, by far.The only exceptions are a few well-written actual manuals, which werethe only worthwhile working guides I had before finding this book.But they don't explain how to write manuals. Otherwise, I bought 3books on "how to write tech manuals" by other authors, butThe User Manual Manual is the only one I would bother using. The restwere too academic, dry, dense, lengthy or flowery. Michael Bremertakes care of the tech writer, walking you through every step ofmanual planning and writing. His approach reminds me of a friend I'm lucky to have, a computer instructor at my local City College who isvery popular with his students. He originally taught me how to use myfirst computer. Then there is my geeky friend who tutored me on howto use multiple programs to run my business. Now I'm an independenttech writer, but not part of a big team like most manual writers. I'mmostly on my own, and now The User Manual Manual will be my bridgefrom learning software to writing tech manuals. It's like MichaelBremer is standing at my desk and helping, being friendly and patient.None of my questions are dumb questions. And I'm full ofquestions!Thank You, Michael Bremer. Gina Ryerson

Great guide to writing for the 'untechnical'

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

how to write technology user guides for lay persons

The User Manual Manual - How to Reserch, Write, Test, Edit andProduce a Software Manual by Michael Bremer. UntechnicalPress. 1999. 314 pp.; 7" x 10" (0-9669949-1-4). charts, illustrations, appendices, bibliogaphy, index. In this second book for writers by Michael Bremer, he continues his guidance on writing about technical subjects for lay readers. Bremer's first book, Untechnical Writing, covered the field of technical writing in general; this The User Manual Manual, as the title says, deals with manuals for lay persons on how to use computer software. The importance of such manuals for computer users these days is apparent. Bremer makes the points that easy-to-follow manuals obviously make it easier for lay persons to operate computers using the software; which means that such manuals are clearly to the benefit of computer makers and software developers. And he makes the second point that easy-to-follow manuals reduce the support computer manufacturers and software producers have to provide to customers. As self-evident as these points are, Bremer wonders if companies in the computer and software business have grasped them--as probably do the majority of lay persons trying to make sense of most user manuals. With more than 20 years in technology industries, including manager of writing teams, Bremer knows the elements, slant, and aims of user manuals inside out, including how they are developed by teamwork among segments of a company and also the creativity and skills of individual writers. He gives experienced, detailed, relevant advice and directions for making a user manual satisfy its ultimate aim of being reader-friendly and therefore contributing to the place of computers and software in individuals' lives.Henry BerryBook ReviewerEditor/Publisher, The Small Press Book Review END