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: How do hiring companies view TW resumes? From:Peter Neilson <neilson -at- windstream -dot- net> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 02 Apr 2010 02:49:26 -0400
Keith Hood wrote:
> something like a bulldozer, what documentation can't be done unless the writer puts his hands on the item?
Nearly all of it. You've got to breathe the stuff to get it right.
Here's some documentation from a tractor manual. There are several
glaring errors. Find them.
Inspection and Repair
Inspect knee bushings (E) for wear and scoring. Bushing I.D. should be
1.1811 to 1.1824 inch (30.0 to 30.03 mm).
Inspect spindle shaft for wear and scoring. Shaft O.D. should be 1.1795
to 1.1803 inch (29.96 to 29.98 mm).
NOTE: the shaft-to-bushing clearance should be 0.001 to 0.003 inch (0.03
to 0.08 mm) but no more than 0.10 inch (0.25 mm).
Inspect thrush bearing (D, Fig. 8.), seat (C) and O-ring (I) for wear.
Replace if necessary.
12. Check that each lever moves to the retract position and returns
freely to its neutral position when released.
If bushings must be replaced, drive old bushings out with a long draft.
Drive new bushings into flush with end of tube using 27504 Disk and
Driver (Fig. 9). Measure new bushings after installation. If necessary,
hone new bushings to the New Part specification (see Group 00).
IMPORTANT: Since the shaft and spindle is an integrated unit, it should
be carefully inspected for cracks. If there is any question about the
condition of the unit, it should be inspected by Magnaflux or a similar
crack-detection process.
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-