documenting technique

Subject: documenting technique
From: Sean Hower <hokumhome -at- freehomepage -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 10 Dec 2002 07:21:44 -0800 (PST)



---------------------------
Mike Bradley asked:
What would a professional mechanic, who had probably completed some factory training, have done? Should the manual have told him to keep track of the bolts?
---------------------------

I think that would fall under the "don't teach them their job" clause of technical writing. If they're professionals, they have their own methods of handling such cases. The manual should, however, note that the screw are of different sizes to give the mechanic a heads up.

That said, I just got done doing server install instructions that _did_ do a little on the job training, but that's mostly because the audience was assumed to have little to no experience.

********************************************
"And in the morning, I'm makin waffles." ~ Donkey
Sean Hower - tech writer
http://hokum.freehomepage.com

_____________________________________________________________
Create your own web site for FREE at http://www.freehomepage.com

_____________________________________________________________
Select your own custom email address for FREE! Get you -at- yourchoice -dot- com w/No Ads, 6MB, POP & more! http://www.everyone.net/selectmail?campaign=tag

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

Order RoboHelp X3 in December and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l

---
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.



Previous by Author: Re: history of tech writing
Next by Author: perception of user experience levels
Previous by Thread: RE: Favorite TW Book?
Next by Thread: perception of user experience levels


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads