TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:What should we call our technical manuals? From:Peggy Solovyov <e_me_peggy -at- yahoo -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 23 Oct 2006 21:03:07 -0700 (PDT)
Hello,
We're having a discussion at work. What should we call our big "phat" manuals? We create manuals that contain "sub-manuals" that are comprehensive for all aspects of specific oil and gas drilling equipment and software related to the equipment. Suggested terms are Owner's Manual and User's Manual. But neither name quite covers the scope of the manual. And the big manual must be bound in a few binders. The manuals are constructed as shown in the following list:
Owner's Manual or User's Manual, which is made up of other manuals (sub-manuals).
Sub-manual named Service Manual (for equipment), which contains the following chapters: General Information, Overview, Installation, Operation, Maintenance, Troubleshooting, Spare Parts List, Customer Service Contact List, and Appendix of vendor-supplied documents.
Sub-manual named Control System User's Manual (for software--confusing?), which contains the following chapters: General Information, Overview, Installation, Operation, Maintenance, Troubleshooting, Customer Service Contact List, and Appendix of vendor-supplied documents.
Sub-manual named Technical Drawing Package, which contains all the engineering drawings related to the equipment.
Is there a name for a comprehensive collection of information as described in this message? Would "Technical Document Package" be a good name for the big phat manual?
Thanks for your help,
Susolov
---------------------------------
Get your email and more, right on the new Yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
