Re: Minimal Contents of a Operation/User Manual
My employer received a machine that we specified and another company build
under contract. The contract called for an operations manual. The machine
is very complex, but we received only a one-page (very general) operation
manual. He has asked me to determine the prevailing definition of an
operation/user manual by content.
I don't think there's an industry standard definition, because the required content in such a manual depends so intimately on the situational context.
I'd say that an adequate user manual contains enough information to allow the intended user to use the functions of the device. (The distinction between "adequate" and "superior", for me, has to do with how the material is organized and whether it's presented in a form that's easily absorbed and used.) So I would ask three questions to determine whether a given user manual is adequate:
1. Who is the intended user? That is, what skills and knowledge is the user expected to bring to the task? (A user manual intended for a skilled machinist will necessarily be different from one intended for an unskilled novice, for example. If you can assume the user has certain skills and knowledge already, you won't need to explain certain things.)
2. What are the functions of the device?
3. Does the manual adequately explain, to the target user, how to use those functions? If not, I would say it's not adequate.
It would be reasonable to ask the contractor for their answers to questions 1 and 2 as well. It may well be that they're making different assumptions about the knowledge level of users, the functions that need to be documented, or both.
jeanne a. e. devoto ~ jaed -at- jaedworks -dot- com
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. http://www.componentone.com/doctohelp .
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.
- Re: Minimal Contents of a Operation/User Manual, Dick Margulis
Previous by Author:
RE: Found out what Docutool is :)
Next by Author: Latin semi-literacy
Previous by Thread: Minimal Contents of a Operation/User Manual
Next by Thread: Re: Minimal Contents of a Operation/User Manual
Search our Technical Writing Archives & Magazine