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.
>1. Pound the nail into the wall. Use a hammer. [The triviality of these
> examples really detracts from the points we're trying to make, don't
> you think?]
>But not:
>4. Cut the red wire leading to the detonator assembly. But first, ground
> the blue wire.
Someone else (didn't see a sig) wrote:
>A more liberal (modern?) approach is to assume the
>reader knows their tools and simply state the task:
>"Pound the nail in the wall." As an ex-technician and
>reader of hardware manuals, I personally prefer this
>style. Telling me which tool to use was irritating and
>condescending.
After hearing some feedback from our technicians (and from
the additional support for this idea that I'm seeing here),
I'm beginning to sway toward this style for more technical
audiences.
I recently heard a friend (a former manufacturing engineer in
the aerospace industry) say that he always writes instructions
in narrative form and thinks that numbered instructional steps strike
him as condescending. I find this position pretty strange because
it goes against most of the conventions I've seen in practice.
Has anyone else heard such suggestions, or does anyone else
practice this method?
Bill Burns
Assembly Training and Documentation Supervisor
WBURNS -at- MICRON -dot- COM
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-