DocumentCode
1514726
Title
Well-written documentation leaves nothing to imagination
Author
Gudknecht, Alan R.
Author_Institution
Sperry Univac, P. O. Box 500, Blue Bell, PA 19424
Issue
3
fYear
1982
Firstpage
112
Lastpage
119
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.
Keywords
Assembly; Calibration; Documentation; Maintenance engineering; Manuals; Monitoring; Personnel;
fLanguage
English
Journal_Title
Professional Communication, IEEE Transactions on
Publisher
ieee
ISSN
0361-1434
Type
jour
DOI
10.1109/TPC.1982.6447772
Filename
6447772
Link To Document