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: Jobs in the G.W.N and one quick Q From:Marguerite Krupp <mkrupp -at- cisco -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 12 Sep 2002 11:09:51 -0400
Ugly stuff, Erin!
Keith Cronin's right about company policy dictating the usage, BUT, here in
the U.S., at least, using the product name as a noun can endanger the
trademark. That is, in theory, at least, you must always use the product
name as an adjective. Because this leads to REALLY awful mouthfuls of words
["The VPN 3000 Series Concentrator device," for example], we usually spell
out the whole thing once and thereafter refer to it as "the Concentrator."
You could say the "Such-and-such application" once and establish the short
form, then refer to it thereafter with just the short form alone, using
initial cap on the name. I think you probably don't need italics.
Sounds like Planner and Manager are really *modules*, not "applications" on
their own. Again, corporate terminology applies, but calling them
"applications" implies that they can exist outside the parent application,
which could be misleading if that's not the case.
Now in your case, the product mangler has probably heard some such stuff and
is trying to apply the principle religiously.
I like your idea about substituting "you" for "the user," too. The current
usage is really distancing.
A suggestion: Do a couple of pages in your suggested style and run it by the
pm to get his/her buy in. Show how it helps "the user" get to the meat of
the description in a hurry. Listen to what the pm has to say; talk it over.
You may find that the pm never even thought of doing it any other way!
HTH,
Marguerite
...
> I have been going through and deleting the extreme overuse of
> the words
> "the" and "application," so my example sentence would now
> read, "The Manage
> Plans button found throughout Planner links the user to
> Manager..." Maybe
> I'd italicize 'Planner' and 'Manager' or something, and if I
> wanted to get a
> little bit more nit-picky, I'd take out the reference to "the
> user" because
> I dislike that one too...
>
> My Q: Tell me, is it "proper" technique to say "the Such-and-such
> application" every time one references the application by
> name? What do you
> think?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Absolutely FREE! FrameMaker/Win 6 & 7 Express Customization (v3):
Quick-access buttons & keys to common functions, char tag/font drop-down
lists, charset browser, QRef guides & much more: http://www.microtype.com/2
Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.