Re: When users want jargon

Subject: Re: When users want jargon
From: "Mary T. Shaw" <smartblonde57 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 3 Jun 2002 13:15:51 -0700 (PDT)

--- Anita Legsdin <anita -dot- legsdin -at- watchmark -dot- com> wrote:
> How far should one go to satisfy the jargon needs of
> a customer? If we put
> it in, the documentation won't be understandable by
> other clients.
> Possibilities: a conversion table that says "For
> information on X, see Y."
> or, add their unusual words to the index.

I would use *standard* terminology throughout the
manual. If a particular client chooses to deviate
from the standard terminology for something, they do
it at their own risk.

To placate those types, though, maybe you could
include alternative terminology in an introductory
section of the manual, or anywhere you place
conceptual info aside from procedures. For example:
"This section describes the tasks you need to perform
for system configuration. Note: Depending on your
site-specific conventions, these procedures may be
called "provisioning" or "xyz"......"

Alternatively, you could prepare a "dictionary" for
each non-standard client, in which you map the
standard terminology to their nonstandard jargon.
This dictionary would be a small supplement to the
standard documentation.


-- Mary T. Shaw

"It's been a wild ride...."

Do You Yahoo!?
Yahoo! - Official partner of 2002 FIFA World Cup

Free copy of ARTS PDF Tools when you register for the PDF
Conference by May 15. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD.

Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to
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 for more resources and info.

When users want jargon: From: Anita Legsdin

Previous by Author: Re: Stan Lee was a TW!
Next by Author: Re: vendor documentation in manuals
Previous by Thread: RE: multiple versions
Next by Thread: Re: When users want jargon

What this post helpful? Share it with friends and colleagues:

Sponsored Ads