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 find "you" much the best choice of the alternatives available.
>I've seen people try to "solve" this problem by establishing a
>name like Fred, and then referring to "Fred" and "he" and I
>find that really klutzy. And as I strongly believe in gender-
>neutral language, "you" and "their" win out.
I tend to favor the second person, as well, although I use "you" in small
doses. Usually, sentences are imperative. Click this, select that. The
subject is still "you" but it's implied--there's no clumsy repetition of
"you do this, then you do that." If necessary, I might write something like
"When you click X, the blah-blah window does such and such." "Click X. The
blah-blah window does such and such." also works, but I think too many of
those constructions would get choppy.
I also agree that using names throughout would become very clumsy and
distracting. I think it works well in specific situations, though,
especially if you want to provide a concrete example of a process that has a
variety of choices.
The example that comes to mind is documentation I wrote for a courseware
access system for military personnel. They had to select folders matching
their squadron, wing, then job description to find their assigned courses.
So, I used numbered steps, but also included an example. (LT Smith is a
mechanic in such-and-such squadron, Wing 7. To find his courses, he
selects....) To me, that seemed clearer than the steps alone. This use
seems common in training materials and much less so in user manuals, from
what I've seen.
As Janice pointed out, "you" and "their" also have the advantage of gender
neutrality. So do imperative sentences with no written subject. Of course,
using "their" brings up another can of worms--whether it's permissible to
use "their" to essentially mean "his or her" or whether a plural subject is
needed. (My vote is for the plural subject, but that strays a bit beyond
the original 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-