Cover Page ofThe Mayfield Handbook of Technical & Scientific Writing
Table of ContentsWriting TimelineHelpCredits


User Documentation

User manuals help the user adapt a technology to his or herpurpose. The sale of any complex technology, whether computer,car, tape recorder, or spectroscope, implies the inclusion ofadequate information to enable the user to use the technologysafely and effectively. A good manual (hard copy or electronic)is a necessary tool to enable the user to use the technology. User manuals are valuable aids for training inexperienced users, enabling skilledoperators to use the technology, and instructing techniciansin how to repair or modify the technology.

User manuals generally provide the following information:

Safety warnings and tips

Typical applications and capability of the technology

Descriptive system overview with illustrations

Functional description of subsystems

Instructions for operating the system

System maintenance requirements

Parts lists

Troubleshooting instructions

These topics may all be treated together in a larger manual, or any of them may be the subject ofa specialized manual such as a repair manual, an installation manual, a maintenance manual, oran operating manual.

User Manual Style

General style for user manuals should be clear and concise. The following section from an OCR scanning manualdemonstrates clear manual organization and style.

Chapter 3

Scanning Tips

This section explains how to achieve the best recognition accuracy possible. See the online Helpfor more detailed information.

Improve OCR Accuracy

OCR accuracy depends on the quality of the scanned image. You'll have very few errors if youscan sharp, laser-printed documents. Scanning faxes, dot matrix documents, and poorly printedpages may produce unacceptable results.

Take the following factors into account when you scan a page:

--Caere Corporation, OmniPage Limited Edition Manual

Reference Link Text
## User Documentation ##
Reference Link Text

[ Home | Table of Contents| Writing Timeline | Index |Help | Credits]

Copyright ©2001 The McGraw-Hill Companies. Any use is subject to the Terms of Use and Privacy Policy. McGraw-Hill Higher Education is one of the many fine businesses of
The McGraw-Hill Companies, Inc.
Corporate Link