Designing and writing operating manuals

Abstract

A manual should communicate the design engineers' intentions for the operation of a process. To do this, it must be accurate, detailed, and logical, and it must be completed in time for the startup. Steps in preparation are structuring the manual; gathering and organizing information; making an outline; writing a draft; checking for technical accuracy; reviewing for consistency, style, and format; cross referencing and making an index; and distributing and accumulating updates and corrections.

Journal
IEEE Transactions on Professional Communication
Published
1984-03-01
DOI
10.1109/tpc.1984.6448766
CompPile
Search in CompPile ↗
Open Access
Closed
Export

Citation Context

Cited by in this index (1)

  1. Journal of Technical Writing and Communication

References (0)

No references on file for this article.