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:Re: tools-how specific in a hardware manual From:"Dan S. Azlin" <dazlin -at- SHORE -dot- NET> Date:Sat, 25 Feb 1995 03:18:43 -0500
On Fri, 24 Feb 1995, Kelly Kremin painfully wrote:
> Finishing a hardware manual. My mgr want me to include specific tools
> in procedures.
> Use an xx hex wrench to remove the two xx screws that connect the
> bracket to the Z column.
> The mechanical engineers is against this. He can't guarantee what
> screw (or bolt or whatever) might be used in a given situation & the
> potential for the manual to include incorrect info is high. Also, he
> says, service people will have complete sets of tools. Plus they are
> tool & part literate.
> Remove the two screws that connect the bracket to the Z column.
> Our dept does not have a style guide (I've tried for one repeatedly).
> Other hardware info is inconsistent, sometimes there's specific info.
> Or not.
> So, opinions? Experiences? Recommendations?
The mechanical engineers are basically correct. After writing many, many
_industrial_ hardware manuals, I have learned that the best course of action
is to assume some basic tool knowledge on the part of the reader and use
only generic references to required tools, if any.
The exception to this rule is when the tool to be used is not intuitive
or has some special requirement, or requires some special consideration
in its use (e.g. using a torque wrench instead of some other kind of
wrench).
To do other than this runs the risk of alienating the reader by
excessively insulting his intelligence and giving him cause to ignore
more important information that you are trying to convey.
IMHO
Dan Azlin ** Word Engineers, Technical Writing & Publishing **
dazlin -at- shore -dot- net ph/fax 508-921-8908
