Techwriting in "real life"

Subject: Techwriting in "real life"
From: Paul Strasser <paul -dot- strasser -at- WINDSOR-TECH -dot- COM>
Date: Wed, 28 Apr 1999 09:38:20 -0500

How do you folks react to Truly Awful Instructions for "everyday" products?

My most recent encounter with TAI dealt with the rather mundane task of
installing curtain rods. The instructions that came with these rods were
mind-numbing. They included the mention of arcane and seemingly
non-existent parts ("cams", for example) that are neither defined,
described, or illustrated. There should be two of these cams and one must
be turned counter-clockwise, the other clockwise. If they aren't turned
properly some undefined yet dreadful thing will happen. For the life of me,
I can't find a cam.

Measurements are shown with no description of what should be done with them
or what they're for. "Go To" statements are included that Go Nowhere.

And for all of us dealing with the needs of translations to other languages,
the instructions simply toss three different languages on the same page,
switching between languages line-by-line. (why not word-by-word?)

Other than using this as an example of things to avoid in technical
writing -- and there is certainly value in understanding what makes
something bad (like those marvelous "websites that suck" URL's), have any of
you ever contacted the offending company and either complained or offered
your services to improve their instructions?

Paul Strasser


From ??? -at- ??? Sun Jan 00 00:00:00 0000=



Previous by Author: Re: What makes a tech writer?
Next by Author: Re: Reselling existing corporate work
Previous by Thread: JOB: Interface Design Lead
Next by Thread: Re: Techwriting in "real life"


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


Sponsored Ads