Abstract

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.

Journal
Written Communication
Published
1987-10-01
DOI
10.1177/0741088387004004003
CompPile
Search in CompPile ↗
Open Access
Closed
Topics
Export

Citation Context

Cited by in this index (3)

  1. Written Communication
  2. Journal of Business and Technical Communication
  3. Journal of Business and Technical Communication

References (30) · 1 in this index

  1. Computer aided authoring and editing
  2. Development of a quality assurance methodology for the technical information generating s…
  3. Technical documentation staff study report
  4. 10.1075/idj.2.3-4.09duf
  5. Designing usable texts
Show all 30 →
  1. The technology of the text
  2. 10.1177/001872088302500202
  3. An experimental comparison of procedural and conventional electronics troubleshooting
  4. Rhetorical problem solving: Cognition and professional writing
  5. Diagnosis in revision: The experts option
  6. Writing: The nature, development, and teaching of written communication
  7. Written Communication
  8. Impact of advanced maintenance data and task oriented training technologies on maintenanc…
  9. Designing usable texts
  10. Improved management of maintenance manuals needed in DOD
  11. Technical order managers reference data
  12. Cognitive processes in revision
  13. Fully proceduralized job performance aids
  14. Designing usable texts
  15. Computer readability editing system
  16. Derivation of new readability formulas (Automated Readability Index, Fog Count, and Flesc…
  17. Operational consequences of a literacy gap
  18. Technical Communication
  19. Evaluation of three types of technical data for troubleshooting
  20. Revising computer documentation for comprehension: Ten exercises in protocol-aided revision
  21. Study and proposal for improvement of military technical information transfer methods
  22. Designing usable texts
  23. Technical Communication
  24. Navy technical manual system (NTMS) program summary
  25. Editing for comprehension: Improving the process through reading protocols