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: Where to report deprecation? From:"William Turner" <wturner -at- force10networks -dot- com> To:<guy -at- hiskeyboard -dot- com> Date:Fri, 5 May 2006 09:17:51 -0700
I agree with the reply from Kenneth Nuckols about listing the deprecated
commands in a preamble to relevant books. That's what we do (Force10
Also, in our CLI references, which are comprised of command syntax
statements, each syntax statement includes a field listing the command
history (in what software version the command was introduced, modified,
or removed). The statement also includes the migration path, which
typically contains links to the deprecated and replacement commands.
When the migration path might be confusing (I have a current case
involving one complicated command replaced by several simpler ones), we
include an explanation that might include showing an example of how to
use both methods. Depending on the complexity and how engrained the use
of the older method was, we might keep that explanation of the use of
the older method in the book through a number of editions.
BTW, I am confused by Kenneth's comment "It would also be nice to have
an explanation of how long before deprecated commands will no longer be
supported." By our definition, a deprecated command is one that is no
longer supported...in the software (or does he mean "supported by Tech
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l