W3C

Checklist of Checkpoints for "QA Framework: Specification Guidelines"

This version:
qaframe-spec-ics
This document is an appendix to:
Latest version of "QA Framework: Specification Guidelines":
http://www.w3.org/TR/qaframe-spec/
Editors:
Dominique HazaŽl-Massieux (dom@w3.org)
Lofton Henderson (lofton@rockynet.com)
Contributors:
See Acknowledgments in QA Framework: Specification Guidelines.

Abstract

This document is an appendix QA Framework: Specification Guidelines [QAF-SPEC] . It provides a tabular checklist of all checkpoints from the specification guidelines, sorted by their priorities. Please refer to QA Framework: Specification Guidelines [QAF-SPEC] for the full statement and description of the specification guidelines and checkpoints, as well as references to related documents and full credits and acknowledgements of contributors to the specification guidelines work.

Status of this document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. The latest status of this document series is maintained at the W3C.

This document is derived from and is an appendix to QA Framework: Specification Guidelines [QAF-SPEC] , which document is a W3C Working Draft (WD), made available by the W3C Quality Assurance (QA) Activity for discussion by W3C members and other interested parties. For more information about the QA Activity, please see the QA Activity statement. Please see the "Status of this document" section of the corresponding specification guidelines [QAF-SPEC] , for complete details about the status of the specification guidelines version from which this is extracted and which it accompanies.

Please send comments to www-qa@w3.org, the publicly archived list of the QA Interest Group [QAIG]. Please note that any mail sent to this list will be publicly archived and available. Do not send information you wouldn't want to see distributed, such as private data.

Publication of this document does not imply endorsement by the W3C, its membership or its staff. This is a draft document and may be updated, replaced, or made obsolete by other documents at any time. It is inappropriate to use W3C Working Drafts as reference material or to cite them as other than "work in progress".

A list of current W3C Recommendations and other technical documents can be found at http://www.w3.org/TR.


Introduction

This checklist includes all checkpoints from the QA Framework: Specification Guidelines [QAF-SPEC] presented in a tabular format. The checkpoints are presented by order of their priorities, which makes it an appropriate Implementation Conformance Statement for the guidelines.

The presentation is intended to be convenient for organizers and evaluators of QA projects in W3C Working Groups, to facilitate assessing specifications against the checkpoints. The table includes spaces for scoring each checkpoint, "yes" (satisfied), "no" (not satisfied), "n/a" (not applicable).

Priorities

For a description of the meaning of the priorities in the following table, please consult the conformance clause and the priorities definition section of the specification guidelines ([QAF-SPEC], chapter -2 and section -2.7) .

Checklist table

Degree A Conformance

To be A-conformant with the guidelines, the following Priority 1 checkpoints must be fulfilled:

NbrCheckpointYesNoN/A

Guideline 1. Define Scope.

1.1

Include a scope statement.

   

Guideline 2. Identify what needs to conform and how.

2.1

Identify classes of product.

   
2.2

For each class of product, define the conformance requirements.

   

Guideline 3. Address the use of profiles, modules and levels to divide the technology.

3.1

Indicate whether or not the use of profiles is mandatory for conformance.

   
3.4

If modules are chosen, indicate any mandatory conditions or constraints on their usage.

   

Guideline 4. Identify the relation between deprecated features and conformance.

4.1

Identify each deprecated feature.

   
4.2

For each class of product, specify the degree of support required for each deprecated feature and the conformance consequences of the deprecation.

   

Guideline 5. Define discretionary items.

5.1

State the circumstances for when discretionary items are allowed.

   
5.2

For implementation dependent values or features, address the allowable differences between implementations.

   

Guideline 6. Allow extensions or not

6.1

Indicate if the specification is extensible, and if extensions are allowed, define their scope and constraints.

   
6.2

Prevent extensions from contradicting the specification.

   

Guideline 7. Clearly identify conformance requirements.

7.1

Use conformance key words.

   
7.2

Distinguish normative and informative content.

   
7.3

Use consistent terminology.

   
7.5

Make normative reference to specifications on which the current specification depends

   

Guideline 8. Document the conformance policy.

8.2

If special conformance concepts are used, include a definition in the specification.

   
8.3

Justify any usage of a dimension of variability.

   
8.4

Include a conformance section.

   
8.5

Identify and define all conformance designations.

   

Guideline 9. Specify how to make conformance claims.

9.3

Impose no restrictions about who can make a claim or where claims can be published.

   

Degree AA Conformance

To be AA-conformant with the guidelines, the following Priority 2 checkpoints must be fulfilled (in addition to the above Priority 1 checkpoints):

NbrCheckpointYesNoN/A

Guideline 1. Define Scope.

1.2

Illustrate scope.

   
1.3

Illustrate functional details.

   

Guideline 2. Identify what needs to conform and how.

2.4

If there are several classes of products, define their relationships and interaction with other dimensions of variability.

   

Guideline 3. Address the use of profiles, modules and levels to divide the technology.

3.2

If profiles are chosen, define any minimal requirements.

   
3.3

If profiles are chosen, address rules for profiles.

   
3.5

If profiles, modules or levels are used, define their relationships and interaction with other dimensions of variability.

   

Guideline 4. Identify the relation between deprecated features and conformance.

4.3

If deprecated features exist, define their relationships and interaction with other dimensions of variability.

   

Guideline 5. Define discretionary items.

5.3

Indicate any constraints on the number of choices/options that can be implemented for discretionary items.

   
5.4

Promote consistent handling of discretionary choices.

   
5.5

If discretionary items are used, define their relationships and interaction with other dimensions of variability.

   

Guideline 6. Allow extensions or not

6.6

If extensions are allowed, define their relationships and interaction with other dimensions of variability

   

Guideline 7. Clearly identify conformance requirements.

7.4

Provide a fast way to find conformance information.

   

Guideline 8. Document the conformance policy.

8.1

Specify any universal requirements for minimum functionality.

   

Guideline 10. Provide test assertions.

10.1

Provide test assertions

   
10.2

Provide a mapping between the specification and the test assertions list.

   

Degree AAA Conformance

To be AAA-conformant with the guidelines, the following Priority 3 checkpoints must be fulfilled (in addition to the above Priority 1 and Priority 2 checkpoints):

NbrCheckpointYesNoN/A

Guideline 2. Identify what needs to conform and how.

2.3

Identify the applicable specification categories.

   

Guideline 4. Identify the relation between deprecated features and conformance.

4.4

Include an explanation for the deprecation.

   
4.5

Include examples to illustrate how to avoid using deprecated features.

   
4.6

Identify each obsolete feature.

   

Guideline 6. Allow extensions or not

6.3

Define a uniform mechanism to create an extension.

   
6.4

Require that extensions be published.

   
6.5

Mitigate the impact of extensions on interoperability.

   

Guideline 9. Specify how to make conformance claims.

9.1

Provide specific wording of the claim.

   
9.2

Provide a conformance disclaimer.

   
9.4

Provide an Implementation Conformance Statement proforma.

   
9.5

Require the ICS be completed as part of the conformance claim.

   

References

QAF-SPEC
QA Framework: Specification Guidelines, D. HazaŽl-Massieux, L. Rosenthal, L. Henderson, Eds., W3C Working Draft, 12 September 2003, available at http://www.w3.org/TR/2003/WD-qaframe-spec-20030912/.