RE: Where to report deprecation?
From: "William Turner" <wturner -at- force10networks -dot- com>
To: <guy -at- hiskeyboard -dot- com>
CC: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Where to report deprecation?
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
Don?t just search. Find. Check out the new MSN Search! http://search.msn.click-url.com/go/onm00200636ave/direct/01/
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
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com
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
http://www.techwr-l.com/techwhirl/ for more resources and info.
Previous by Author:
RE: punctuating the end of bullet points
Next by Author: RE: FrameMaker numbering resets to 1 after an anchored frame
Previous by Thread: RE: Where to report deprecation?
Next by Thread: RE: Where to report deprecation?
Search our Technical Writing Archives & Magazine