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

[SpecGL Draft] E. Good Practice: Do a systematic and thorough review.

From: Karl Dubost <karl@w3.org>
Date: Tue, 13 Jul 2004 13:56:42 -0400
Message-Id: <FF93666A-D4F5-11D8-B69B-000A95718F82@w3.org>
To: www-qa-wg@w3.org
Good Practice:
	Do a systematic and thorough review.

What does that mean?
	Each part of a technology should be reviewed by the WG before 
publication, but also during the editing phase. It will help the 
Working Group to identify missing pieces, spelling mistakes, 
ambiguities, dependencies. With a well defined review process inside 
the Working Group, it should not be difficult to achieve this issue.

Why should I care?
	When a Working Draft is published with incomplete or very drafty 
section, the WG might receive a lot of comments which will be have to 
be answered at best, and that will still be in the final Recommendation 
document at worse. Catching early the mistakes will decrease the number 
of comments and so time and resources to handle them.

Related:
	Editor's Guide?
	Maybe stuff in Style Guidelines

Techniques:
	1. Create a simple and light review process. Perhaps, establish a 
team, where each person focuses on a different aspect of the 
specification's correctness.
	2. Organize at least one review cycle before publication (more if you 
can)
	3. Organize the review by topic and expertise. For example, each 
person checks a different part of the specification or do it by 
expertise - the grammarian checks for consistency, grammar, spelling, 
readability, the test builder checks requirements for precision and 
implementability, the conformant checks that conformance criteria 
exists.

Examples:
	XHTML 1.0: If you submit a web page address to the W3C MarkUp 
Validator, it could happen that the result page tells you that your 
document is "Valid XHTML 1.0 Strict" and provides a link to the XHTML 
1.0 Recommendation. If you follow this link you will encounter a 
problem: There is no definition of what it means for a document to be 
identified as "Valid XHTML 1.0 Strict".

	Work Method of RDF/OWL? Jeremy Carrol?
	Templating method and review for SpecGL Lite?


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

Received on Tuesday, 13 July 2004 17:33:06 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 6 January 2015 21:14:33 UTC