[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Where to report deprecation?

Subject: Re: Where to report deprecation?
From: "Laura Lemay" <llemay -at- gmail -dot- com>
To: "Guy K. Haas" <guy -at- hiskeyboard -dot- com>
Date: Fri, 5 May 2006 13:19:47 -0700

Guy asks about how to talk about deprecation. Lots of people replied
but I thought I'd chime in with what I've done:

+ "Migrating from Version X to Version X++" is a chapter or appendix
in the dev guide (depending on how much content it contains) and
includes specific deprecation information, how to replace deprecated
code, and so on -- but may also contain other information about
updating old code, more efficient ways of implementing common tasks,
etc.

+ The migration chapter is pointed out in the release notes and in
the introductory chapters to the dev guide.

+ The dev guide covers the current release only.

+ The API docs cover the deprecated APIs if they are still included
in the code. The compiler should print a warning if you use
deprecated APIs, of course. The API docs should also point to the
migration chapter for deprecated APIs.

Once deprecated APIs are removed from the code they are no longer
deprecated, they are removed. At that point they are also removed
altogether from the docs as if they never existed. Poof.

Laura

--
*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^
Laura Lemay Killer of Trees lemay % lne.com lemay % gmail.com
http://www.lauralemay.com http://blog.lauralemay.com
*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^*^

On 5/4/06, Guy K. Haas <guy -at- hiskeyboard -dot- com> wrote:

In a reference manual, or in Javadoc, documenting deprecation is taken
as a matter of course; the deprecation is called out at the point the
class or method is described. Typically, we want to say what OTHER
class or method to use it its place ("lmno is deprecated in favor of qrst").

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.

References:
Where to report deprecation?: From: Guy K. Haas

Previous by Author: Re: TOP THAT: Antique Email (WAS RE: Dating the Internet (was Re: Funny Tech Writing))
Next by Author: RE: Configuration Control of Help Files
Previous by Thread: Where to report deprecation?
Next by Thread: RE: Where to report deprecation?

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads