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

[SpecGL Draft] D4 Identify each deprecated feature.

From: Karl Dubost <karl@w3.org>
Date: Mon, 28 Jun 2004 17:36:29 -0400
Message-Id: <377C8410-C94B-11D8-8A27-000A95718F82@w3.org>
To: www-qa-wg@w3.org
Lynne, Yours to review ;)

D.4 Deprecation

Previous:
---------------------------------------------
Principle:
	Identify each deprecated feature. If there are deprecated features 
from a previous specification version, let the reader know about them.
---------------------------------------------

Proposal:
---------------------------------------------
Principle:
	Identify each deprecated feature.

@@Need to define deprecated feature@@ (See the mail about 
deprecation/obsolete in www-qa)

Meaning:
	When a new version of a technology is created, needs evolve. It will 
be necessary to keep a detailed list of the deprecated features of the 
previous version of the specification.

Care:
	When the technology is implemented, it helps the developer to know 
which features will be superseded in the next version of the 
technology. It will also be easier to implement conversion mechanisms 
when necessary.
	It will help the user of the technology to know what are the features 
at risk when they create document and encourage them to use new 
appropriate methods.

Related:
	@@Look for references on deprecation@@
	

Technique:
	1. Create a list of all features that are not encouraged anymore.
	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 specification

Examples:
	"HTML 4.01" [0]
		The specification has a full list of "elements" [1] and "attributes" 
[2]. The deprecation status is given in the two lists.
		There is an entry in the table of content to these two lists.
		Each element/attribute is linked to its definition in the 
specification

	[0]http://www.w3.org/TR/1999/REC-html401-19991224/
	[1]http://www.w3.org/TR/1999/REC-html401-19991224/index/elements.html
	[2]http://www.w3.org/TR/1999/REC-html401-19991224/index/attributes.html
	
	IRI Avoid doing. Section 2.2 .2 Use of IRIs as Namespace Names in 
Namespaces XML 1.1 discusses the deprecation of relative IRI 
references. Difficult to find, luckily this is a very short Rec.
---------------------------------------------



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

Received on Monday, 28 June 2004 19:25:29 GMT

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