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.
Thanks to Mike West, Yves Jaurond, John Posada, and
Darren Butler for making some more good and valid
points in this discussion - and apologies to everyone
who's sick of it. :-)
I am wary of saying "the problem must be with some
members of the audience" (even when it's probably
true), as I am wary of saying "my job is to be as
accurate as possible".
I believe my job is to *communicate effectively* -
which encompasses being as accurate as readers need
and accommodating my audience to the degree that I can
without straying from the original goal. I think that
if my work elicits an emotional reaction, that
detracts from its effectiveness.
I believe that there are two ways that we technical
communicators most often elicit that unwanted
emotional reaction - one is to use language that perks
up the antennae of the professionally offended; the
other is to patronize or insult the intelligence of
our readers by catering to the professionally
offended. (Excellent point, Darren - you are exactly
right. Ask me about phrases like "people who are
pregnant". :-)
One of the ways we prove our worth to our employers is
by writing clear, accurate prose that avoids both
these pitfalls.
Over the years I have found that when I encounter a
sentence or phrase that doesn't sit right with me or
with one of my reviewers, it's usually most effective
to "write around the problem". In the course of this
discussion, it's become clear to me that "master" and
"slave" *are* the right words; the way to write around
any perceived problem these words is to use them as
adjectives. So our application note will discuss
master MagicBoxes and slave MagicBoxes. No problem
there.
"No problem" is the ideal outcome - far better than
"trivial problem", "imaginary problem", or "your
problem". So it's what I aim for. I don't always
achieve ideal outcomes, but I can't *ever* achieve the
ideal without striving for it.
Again, thanks to all who contributed to this thread!
All of you helped me to clarify my own thinking on
this question.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-