Computing Reviews
Today's Issue Hot Topics Search Browse Recommended My Account Log In
Review Help
Search
Creating computer software user guides: from manuals to menus
Houghton-Alico D., McGraw-Hill, Inc., New York, NY, 1985. Type: Book (9789780070304710)
Date Reviewed: Oct 1 1985

After briefly introducing the basic concepts underlying software documentation and discussing the “macrodesign” of documentation, the bulk of this book discusses what the author labels the “microframe.” This includes research procedures for documentation, creating written and online user guides, graphics, editing, and actual production.

This slim book (134 pp. without appendices) was written by someone with first-hand industry experience, an advantage which shines through in the early chapters. Houghton-Alico has sprinkled useful advice in these chapters, including tips on how to obtain assistance from recalcitrant programmers during the early documentation creating phases. The problems created by program updates after field distribution are mentioned instead of being forgotten, as is too often the case. Early research into program functionality is stressed. Though unusual in such a book, several pages are devoted to a discussion of ethics and professional standards as they apply to the documentor. The author is to be applauded for addressing this controversial issue.

This book does, however, display some shortcomings endemic to the continuing rush by publishers to get microcomputer related books on the shelves. It is all too brief, and many topics could benefit from further discussion. For example, menus and prompts are discussed in the chapter on interactive guides, but we are given no insight which can aid in deciding when to choose a particular approach. At the same time, as some topics should be discussed further, there is too much padding in some places. We do not need another list of literary style reference books here, nor is another glossary of computer words appropriate. In fact, all the appendices here (glossary, abbreviations, list of programming languages in use) could have been ommitted, and the bibliography is skimpy.

On balance, this is a good introductory survey of small system documentation techniques. Had more care been taken to incorporate the actual experiences of the author, this book could have been outstanding.

Reviewer:  David Bellin Review #: CR109579
Bookmark and Share
  Featured Reviewer  
 
Documentation (D.2.7 ... )
 
 
Microcomputers (C.5.3 )
 
Would you recommend this review?
yes
no
Other reviews under "Documentation": Date
Illustrating computer documentation
Horton W., John Wiley & Sons, Inc., New York, NY, 1991. Type: Book (9780471538455)
Jun 1 1992
The art of technical documentation
Haramundanis K., Digital Press, Newton, MA, 1992. Type: Book (9781555580803)
Jun 1 1992
Integrated hypertext and program understanding tools
Brown P. IBM Systems Journal 30(3): 363-392, 1991. Type: Article
Nov 1 1992
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