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.
Subject:Re: The double "this" From:"Susan W. Gallagher" <sgallagher -at- EXPERSOFT -dot- COM> Date:Wed, 10 Sep 1997 13:40:02 -0700
At 11:21 AM 9/10/97 +0300, you wrote:
>1) "This flag specifies that this node allows read access
>
> ** I think that the double "this" is inelegant,
> causing the flag and the node to jostle one
> another for the spotlight.
I agree. Then, too, it's relatively inelegant to lead with "this".
Can you repeat the flag name???
The <blahblah> flag specifies...
But, I suspect the real problem is that you're trying not to leave
out any words, which is an all-too-frequent trap. If you've got a
bunch of flags to document, leading with "This flag..." in every
description can be overly repetitive and the reader already knows
which flag your talking about. If this is the case, I recommend
(and do) leave out the "This" lead-in and start with the action
verb, like this:
Specifies read access for the selected node.
Subject understood, reader understands, and not a whole lot of clutter.
Just my... Heck, I guess I should just keep a roll of pennies on
my desk, huh??? ;-)
The _Guide_ is definitive.
Reality is frequently inaccurate. --Douglas Adams
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html