The development of technical manuals requires coordination of the expertise in the subject area and in writing and design skills as well as detailed knowledge of the audience and job context. In this research we examined the production process of five publication houses in an attempt to determine how or if these requirements for expertise are being met. A further goal was to determine what strategies in the production process may facilitate or detract from the production of effective documentation. Writers, managers, and illustrators were interviewed at each site. The work flow in developing a manual is described. Data on the use of specifications and guidelines, the revision process including quality control, validation and verification, are presented. The skills and duties of writers, illustrators, and government representatives are presented. Finally, the production process for technical manuals is interpreted in terms of a process model of writing and strategies for improving the quality of documentation is discussed.
This report has been reviewed by the Office of Public Affairs (PA) and is releasable to the National Technical Information Service (NTIS). At NTIS, it will be available to the general public, including foreign nations. This technical report has been reviewed and is approved for publication.
scite is a Brooklyn-based organization that helps researchers better discover and understand research articles through Smart Citations–citations that display the context of the citation and describe whether the article provides supporting or contrasting evidence. scite is used by students and researchers from around the world and is funded in part by the National Science Foundation and the National Institute on Drug Abuse of the National Institutes of Health.