By Topic

Well-written documentation leaves nothing to imagination

Sign In

Cookies must be enabled to login.After enabling cookies , please use refresh or reload or ctrl+f5 on the browser for the login options.

Formats Non-Member Member
$31 $13
Learn how you can qualify for the best price for this item!
Become an IEEE Member or Subscribe to
IEEE Xplore for exclusive pricing!
close button

puzzle piece

IEEE membership options for an individual and IEEE Xplore subscriptions for an organization offer the most affordable access to essential journal articles, conference papers, standards, eBooks, and eLearning courses.

Learn more about:

IEEE membership

IEEE Xplore subscriptions

1 Author(s)
Gudknecht, Alan R. ; Sperry Univac, P. O. Box 500, Blue Bell, PA 19424

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.

Published in:

Professional Communication, IEEE Transactions on  (Volume:PC-25 ,  Issue: 3 )