Well-written documentation leaves nothing to imagination

Abstract

Good maintenance documentation contributes to product-line image and customer satisfaction. By describing the “personality” of a system, the service introduction can inspire confidence and make many parts of the system virtually self-explanatory. Other sections should tell what is being accomplished (the objectives) rather than dwelling on mechanical manipulations. Systematic and complete troubleshooting techniques cut time and energy from servicing operations. Access to hidden parts must be adequately described. Schematics are the most frequently used part of a service manual — a list of features and aids that make schematics effective is included. Tips on fine tuning the first draft and achieving clarity are given.

Journal
IEEE Transactions on Professional Communication
Published
1982-09-01
DOI
10.1109/tpc.1982.6447772
CompPile
Open Access
Closed
Export

Citation Context

Cited by in this index (0)

No articles in this index cite this work.

References (0)

No references on file for this article.