How To Write Usable User Documentation

How to Write Usable User Documentation

How To Write Usable User Documentation

This popular handbook presents a step-by-step method for clearly explaining a product, system, or procedure. The easy-to-follow text--packed with examples and illustrations--explains the unique demands of this form of writing and shows how to set up the best user model. The book covers developing a modular outline and storyboard, generating the draft, revising, developing a formal usability test, and supporting and updating user documentation. Also included are a glossary of terms, a listing of books and periodicals for additional information, and an index.

Effective Documentation

"Best Collection of Essays", NCTE Awards for Excellence in Technical and Scientific Communication. Effective Documentation is a major sourcebook that offers technical writers, editors, teachers, and students of technical communication a wide variety of practical guidelines based on often hard to find research in the usability of printed and electronic media. The book's eighteen chapters provide a wealth of material on such topics of current interest as the writing of design manuals, research in cognitive psychology as applied to the design of user manuals, and the organizing of manuals for hierarchical software systems. Included are chapters by such well known scholars in the field as Philip Rubens, Robert Krull, Judith Ramey, and John Carroll. Effective Documentation reviews the advice offered by other "how to produce usable documentation" books, describing the different types of usability research and explaining the inherent biases of each type. It goes beyond the actual design of textual and/or electronic media to look at these designs in context, giving advice on effective management ("good management is a requisite of good writing"), on the relationship between document design and product design, and on how to find out who one's readers really are. Advances in the presentation of textual information are explained, with suggestions on how to improve the usability of individual sentences and the design of entire books. The concluding chapters discuss advances in the design and use of online information and offer valuable insights into the use of graphic information and the development and design of information communicated via electronic media. Stephen Doheny Farina is Assistant Professor of Technical Communication at Clarkson University. Effective Documentationis included in the Information Systems series, edited by Michael Lesk.