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:tools-how specific in a hardware manual From:Kelly Kremin <kellyk -at- CYBEROPTICS -dot- COM> Date:Fri, 24 Feb 1995 15:07:54 LCL
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.
