RE: Terminology

Subject: RE: Terminology
From: "Carey Jennifer (Cry)" <jennifer -dot- carey -at- cdi -dot- cerberus -dot- ch>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 6 Feb 2002 13:02:44 +0100

Haven't I seen this before? I seem recall this same discussion just a couple
of months ago and recommend checking the archives.

To respond though: My understanding is that DEPRECATED is standard and valid
terminology in the programming world. HOWEVER, personally, as a Techwriter
who is closer to the User end of documentation, in all of my 8 years of
writing technical documentation, I had never encountered it before that
thread, nor have I had cause to use it. So, standard and correct - yes.
Known by all - No.

Summary: you'll have to decide based on what you know of your audience and
what they know.


Richard Pineger Wrote:


I have written an internal Procedure template for a tech writing house using
the word DEPRECATED to describe a style that is no longer to be used.

Some of the authors here did not know the word and feel that the word is not
really common usage.

I feel that the word is in common usage in the world of techwhirlers and
they should know it. It is used for example by the W3C when defining HTML.
Now all these authors know HTML so they should know DEPRECATED. Otherwise,
when they look in an HTML reference they might get confused.

Am I right to include the word DEPRECATED and attempt to educate them as
well as provide a template for another purpose or should I have searched for
a more common phrase like "not used anymore".

I feel that I would want to use DEPRECATED in other areas, for instance,
internal glossaries, so I really want them to know this word.

I would value your opinions..


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Did you know you can get RoboHelp certified?
To learn how, visit http://www.ehelp.com/techwr. Be sure to also check out
our special pricing offers and promotions for RoboHelp 2002.

---
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.



Follow-Ups:

Previous by Author: legality of web links to articles?
Next by Author: Speaking of Author-It...
Previous by Thread: RE: Terminology
Next by Thread: RE: Terminology


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

Sponsored Ads


Sponsored Ads