Computing Reviews
Today's Issue Hot Topics Search Browse Recommended My Account Log In
Review Help
Search
The art of technical documentation (2nd ed.)
Haramundanis K., Digital Press, Newton, MA, 1998. Type: Book (9781555581824)
Date Reviewed: Jul 1 1998

Haramundanis presents her view of how to produce effective technical documentation to technical writers in the computer industry. She takes the unique, but essentially correct, position that technical writing is not scientific writing but instead is much like investigative reporting. She enlarges on this basic theme with chapters that define her subject, describe a typical career in the field, state the precepts of technical documentation, and tell how to gather and package information. The final three chapters give specific information and advice about graphics; discuss presenting information; and, finally, give a roundup of writer’s tools that have not previously been mentioned.

The last third of the book consists of appendices of up-to-date reference material, including a glossary; an excellent bibliography; lists of societies, conferences, journals, Internet resources, and standards; and descriptions of the two currently fashionable markup languages, HTML and SGML. Every chapter includes clearly marked, useful tips and ends with exercises for the student. The type is attractive and the lines are well spaced. The pages have plenty of space for marginal notes, and the book lies comfortably open on the desk. The index is splendid.

The author knows and understands both her subject and her readers and is an effective writer and teacher. She has produced a book that I can recommend unreservedly not only to technical writers of documentation but to all readers of Computing Reviews, regardless of their professions, who write anything: email, short notes, letters, reviews, theses, fiction, or historical memoirs. Whatever you write will be better if you do it the Haramundanis way.

Reviewer:  Eric A. Weiss Review #: CR121660 (9807-0493)
Bookmark and Share
  Featured Reviewer  
 
Training, Help, And Documentation (H.5.2 ... )
 
 
Reference (A.2 )
 
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