Where to report deprecation?

Subject: Where to report deprecation?
From: "Guy K. Haas" <guy -at- hiskeyboard -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 04 May 2006 12:56:54 -0700

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").

But what about in developer guides -- the more task-oriented books:

* Do you report deprecations in an appendix and just discuss the new way to do things in the chapters?

* Do you treat developer guides as always being forward-looking, and thus leave deprecation reporting to the release notes?

* Do you have any feedback from your readership about what they are expecting or what their reaction was to your choices?

--Guy K. Haas
Software Exegete in Silicon Valley


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: Programs to create a software walk-through?
Next by Author: Re: More Verbification
Previous by Thread: RE: tech writer --> BA
Next by Thread: Re: Where to report deprecation?

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

Sponsored Ads