W3C home > Mailing lists > Public > www-qa-wg@w3.org > June 2004

[SpecGL Draft] D4 Identify obsolete features

From: Karl Dubost <karl@w3.org>
Date: Tue, 29 Jun 2004 14:57:33 -0400
Message-Id: <2DAE51B4-C9FE-11D8-8A27-000A95718F82@w3.org>
To: www-qa-wg@w3.org
D.4 Deprecation

Previous:
---------------------------------------------
Good Practice:
	Identify obsolete features
---------------------------------------------

Proposal:
---------------------------------------------
Good Practice:
	Identify obsolete features

Meaning:
	A feature which has been deprecated in a previous version was at risk. 
You might consider to make it obsolete in your present version of the 
technology. It is necessary to give a list of obsolete features.

Care:
	It gives a clear message to users and developers that obsolete 
features are forbidden and not part of the technology anymore. It will 
help to avoid the creation of documents mixing old and new techniques 
which will be invalid.
	It helps to avoid name clashing. When an extension to a technology is 
created, developers will use nouns for their extended features name. 
Giving the name of obsolete features will help developers to avoid 
using the names of previous features which are now obsolete.


Related:
	References to the Extension section


Technique:
	1. Create a list of all features that are obsolete.
	2. Create a dedicated section for it
	3. Create a entry in the table of content going to this list
	4. For each deprecated feature, create a link to the appropriate 
definition in the previous specification.

Examples:

	HTML 4.01, Appendix A: Changes lists the elements that are obsolete 
and suggests an alternative element for use. "The following elements 
are obsolete: LISTING, PLAINTEXT, and XMP. For all of them, authors 
should use the PRE element instead."
---------------------------------------------



-- 
Karl Dubost - http://www.w3.org/People/karl/
W3C Conformance Manager
*** Be Strict To Be Cool ***

Received on Tuesday, 29 June 2004 17:33:33 GMT

This archive was generated by hypermail 2.2.0 + w3c-0.30 : Thursday, 9 June 2005 12:13:16 GMT