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.
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.
Carey Jennifer (Cry) responded:
>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.
True, but given that deprecated is the term in common use among programmers
(with an obvious inheritance from the original meaning among accountants,
which is by no means the case with all hacker jargon - why cookies, for
example?) isn't it part of our function as techwhirlers to instruct?
I'm fighting a campaign in the Javadoc I'm editing (which I will win <g>
because I get to be final editor, and besides the manager agrees with me) to
have programmers use sentences rather than the one word "deprecated":
"This --- has been deprecated and will be removed in a future release".
"This --- has been deprecated: use the replacement $%&! instead."
Even if the reader happens not to know what "deprecated" means, this gives
them the information they actually need to know, and hopefully next time
they run into it as a single word they'll remember the context and
understand what deprecated means.
HTH, FWIW.
Jane Carnall
The writers all stand around a cauldron chanting and occasionally tossing in
a deprecated rodent.
E-mail is an informal method of communication and may be subject to data corruption, interception and unauthorised amendment for which Digital Bridges Ltd will accept no liability. Therefore, it will normally be inappropriate to rely on information contained on e-mail without obtaining written confirmation.
This e-mail may contain confidential and/or privileged information. If you are not the intended recipient (or have received this e-mail in error) please notify the sender immediately and destroy this e-mail. Any unauthorized copying, disclosure or distribution of the material in this e-mail is strictly forbidden.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
---
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.
