RE: Where to report deprecation?

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 the software (or does he mean "supported by Tech

-- Will

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

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: Re: The Plural of RPM
Next by Author: Re: Localization question?
Previous by Thread: RE: Where to report deprecation?
Next by Thread: RE: Where to report deprecation?

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

Sponsored Ads