Designing Field Research in Technical Communication: Usability Testing for In-House User Documentation

Barbara Mirel Illinois Institute of Technology

Abstract

A current assumption is that “one best system” can be devised to develop and test user documentation. In-house documentation, however, demands approaches that do not fit into a generic system. Specifically, an in-house manual needs a special type of usability testing, one that measures if and how a manual is used to meet the goals of its organization. Along with quality testing, in-house writers must also run studies on how their manuals actually function in the workplace. This article describes a three-pronged design for actual use testing: user logs; observations; and surveys. In my case study, this testing revealed that users did not use their manuals for reasons other than quality — for instance, reliance on social interactions for acquiring information. My findings show that writing an effective manual requires more than composing skills; it demands writers' involvement in the organizational dynamics that motivate workers to use or not use their manuals.

Journal
Journal of Technical Writing and Communication
Published
1987-10-01
DOI
10.2190/3g4g-c1n7-75yk-7a6n
CompPile
Search in CompPile ↗
Open Access
Closed
Topics
Export

Citation Context

Cited by in this index (4)

  1. Technical Communication Quarterly
  2. IEEE Transactions on Professional Communication
  3. Computers and Composition
  4. IEEE Transactions on Professional Communication

References (1)

  1. Designing Usable Texts