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.
> I know that you are adamantly opposed to the use of
> "you" but I still find it hard to believe that you
> consider these rewrites clearer and easier for the
> reader to comprehend than the original sentences.
> To each his or her own, I guess... Our styles are
> so different that it's probably a very good thing
> that we don't work at the same company as writer/
I'd have to agree entirely with Janice on this one,
and I don't think this is just a matter of preference.
The use of passive voice instead of "you" is simply
less accurate. With "you" there is less room for
misunderstanding. If our job is to be as clear and
accurate as possible, why leave it up to the reader to
assume who should be performing the steps in the
procedure? It's nice to know something "can be" done,
but does that mean that I'm supposed to do it, or does
the product do it for me?
I have the same gripe about the use of "will." Unless
it implies something happening in the future, a
present-tense verb is simply more accurate. It gives
the user more information. If I say "The Product
Registration dialog appears," users know it will
happen immediately after they perform the step.
However, if I say "The Product Registration dialog
will appear," who knows when it is going to pop up?
I think it's always a safe bet to choose a specific
word instead of a vague one.
But it's early here, and I probably haven't had enough
coffee yet. :o)
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-