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: Common instruction? From:"Michael West" <mbwest -at- bigpond -dot- net -dot- au> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 28 May 2003 01:09:02 +1000
From: "Linda Stark"
>
> I don't recall ever having run across this before. Is it common to start
> assembly instructions for components of a very large tool with:
>
> 1. Locate six screws....
> 2. Locate two O-rings. Grease them with....
>
> This follows what is supposedly a "parts list" for the whole tool. To me,
it
> sounds like we're having them run out to the garage, find six screws (one
> here, one there, and how about one over there) and finish the step. Then
> they run back out to the garage, find a couple of O-rings laying around
and
> finish that step. This "parts list" by the way is a one-page creation,
with
> a border. The first column lists the name of the item followed by the part
> number; then we have a whole long trail of leaders that take us
to.......the
> quantity, which is at the edge of the margin on the right.
Linda,
You need to determine (if you haven't already)
whether these parts are part of your delivered
package or whether the person doing the assembly
is supposed to provide them. Once you have made the
determination, make it explicit in the instructions.
For example, write "In the packet labelled
'Doodah assembly parts' locate the ..." or
"Before you can assemble the doodah you need
to have the following items (not included):"
I've seen and used an instruction sheet that conveyed
this information wordlessly (via pictures), so I know
it can be done.
"Locate" is engineer's jargon with multiple meanings.
"Locate" can mean "determine the correct position of"
and it can mean "find". Neither of these is exact enough
to tell your assembler what he/she needs to do.
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -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.