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: Terminology question: Deprecated function From:"Susan W. Gallagher" <SGallagher -at- akonix -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 10 Oct 2001 09:42:11 -0700
Don't change anything. "Deprecated" is the correct term; using
anything else would make your readers doubt your credibility.
Functions are deprecated but still supported because there is
a better function to take its place but a customer base that
has included it in code. The deprecated function lives on so
that the customer base does not have to rewrite its code, but
new development is encouraged to make use of the new function.
All you need say in your table is (deprecated)
Your audience will understand immediately. If you use another
term, this will not be the case.
HTH!
-Sue Gallagher
sgallagher -at- akonix -dot- com
> -----Original Message-----
> From: Stern, Geoff [mailto:GStern -at- NetSilicon -dot- com]
> Our software engineers have been using the term "deprecated
> function" to
> mean a function that has been (and still is) fully supported but will
> not be supported in some future version (usually the next one or so).
>
> None of us -- engineers or writers -- likes this term,
> although it seems
> to be widespread usage in API documentation.
>
> Any suggestions for an alternative that's fairly laconic? (It would be
> nice to have something short enough to use in a kind of overview table
> or checklist of APIs.)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announcing new options for IPCC 01, October 24-27 in Santa Fe.
Attend the entire event, select a single day, or sign up for
a Saturday postconference workshop. http://ieeepcs.org/2001
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
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.
