Defining the Manual's Audience, Content, and Level of Detail

by Mike Tidwell, Information Systems Specialist; Greely and Hansen Engineers,



Part of: How to Produce Effective Operations and Maintenance Manuals

Abstract:

Often, the technical writers assigned to prepare an O&M manual aren't technical writers at all, but members of the facility design engineering staff. While they may be good technical writers, converting technical wording from drawings and specifications into a concise understandable document can be challenging. One can easily become lost in most engineering document legalese and jargon alone. It is, therefore, very important to accurately define the manual format, content, level of detail, and audience early in the manual preparation process. This chapter helps you define these key areas.

Subject Headings: Legal affairs | Building design

 

Return to search