Computing Reviews
Today's Issue Hot Topics Search Browse Recommended My Account Log In
Review Help
Search
Writing software manuals
Thirlway M., Prentice-Hall, Inc., Upper Saddle River, NJ, 1994. Type: Book (9780131388017)
Date Reviewed: Mar 1 1996

This short book offers good guidance for writing software manuals. It is intended as a guide for anyone involved in technical writing that supports software products. The book would be of particular value to those who do not have much experience writing user documentation, but there is much good advice for experienced authors as well.

The author assumes that readers have the needed technical knowledge in the software field and concentrates on writing style. There is a heavy emphasis throughout the book on the need for authors to focus on their intended audience in making decisions about appropriate style, tone, vocabulary, and so forth. The author suggests that one purpose of this guide is to provide advice particularly aimed at European audiences. I am not certain what the difference is, except that there are various comments having to do with adopting a writing style that lends itself to easy translation into other languages.

The book contains ten chapters. Those chapters essentially cover a six-step approach that the author uses for writing software manuals. The steps are analyzing the audience, making an outline definition, making a detailed definition, choosing a style and format, writing the manual, and testing the manual. The concluding chapter briefly presents some advice about writing online documentation.

The book is clear, concise, and well written. It makes good use of examples to clarify various points. I had only one minor problem. The book includes an appendix, but I could see no purpose for the appendix other than possibly to illustrate how an appendix should appear in a manual.

Reviewer:  D. C. Hair Review #: CR119442 (9603-0166)
Bookmark and Share
 
Training, Help, And Documentation (H.5.2 ... )
 
 
Documentation (D.2.7 ... )
 
Would you recommend this review?
yes
no
Other reviews under "Training, Help, And Documentation": Date
Designing and writing online documentation: help files to hypertext
Horton W., John Wiley & Sons, Inc., New York, NY, 1990. Type: Book (9789780471507727)
Feb 1 1992
Designing, writing and producing computer documentation
Denton L. (ed), Kelly J., McGraw-Hill, Inc., New York, NY, 1993. Type: Book (9780070164178)
Oct 1 1994
An integrated solution
Hutchinson M., Rockley A.  Systems documentation (, Waterloo, Ont., Canada, Oct 5-8, 1993)1471993. Type: Proceedings
Sep 1 1994
more...

E-Mail This Printer-Friendly
Send Your Comments
Contact Us
Reproduction in whole or in part without permission is prohibited.   Copyright 1999-2024 ThinkLoud®
Terms of Use
| Privacy Policy