Guidelines |
YES |
NO |
N/A |
1 Specifying Conformance
|
1.1 A conformance clause is essential
|
Requirement
:
Include a conformance clause. |
YES |
|
|
Good Practice
:
Define the specification's conformance model in the conformance clause. |
YES |
|
|
Good Practice
:
Specify in the conformance clause how to distinguish normative from informative content. |
YES |
|
|
1.2 Specify how to make conformance claims
|
Good Practice
:
Provide the wording for conformance claims. |
|
no |
|
Good Practice
:
Provide an Implementation Conformance Statement proforma. |
|
no |
|
Good Practice
:
Require an Implementation Conformance Statement as part of valid conformance claims. |
|
no |
|
2. Setting up Groundrules
|
2.1. Scope
|
Requirement
: Define the scope. |
YES |
|
|
Good Practice
:
Provide examples, use cases, and graphics. |
YES |
|
|
2.2 What needs to conform
|
Requirement
:
Identify who or what will implement the specification. |
YES |
|
|
2.3 Normative (and non-normative) references
|
Requirement
: Make a list of normative references.
|
YES |
|
|
Good Practice
: Do systematic reviews of normative references and their implications. |
YES |
|
|
4. Managing Variability
|
4.1 Subdivide
|
Good Practice
:
Create subdivisions of the technology when warranted. |
YES |
|
|
Requirement
:
If the technology is subdivided, then indicate which subdivisions are mandatory for conformance. |
YES |
|
|
Requirement
:
If the technology is subdivided, then address subdivision constraints. |
YES |
|
|
Good Practice
:
If the technology is profiled, define rules for creating new profiles. |
|
no |
|
4.2 Optionality and Options
|
Good Practice
:
Make sure there is a need for the optional feature. |
YES |
|
|
Good Practice
:
Clearly identify optional features. |
YES |
|
|
Good Practice
:
Indicate any limitations or constraints on optional features. |
YES |
|
|
4.3 Extensibility and Extensions
|
Requirement
:
Address Extensibility. |
YES |
|
|
Good Practice
:
If extensibility is allowed, define an extension mechanism. |
YES |
|
|
Good Practice
:
Warn implementers to create extensions that do not interfere with conformance. |
|
no |
|
Good Practice
:
Define error handling for unknown extensions. |
YES |
|
|
4.4 Deprecation
|
Requirement
:
Identify deprecated features. |
|
|
None |
Requirement
:
Define how deprecated feature is handled by each class of product. |
|
|
n/a |
Good Practice
:
Explain how to avoid using a deprecated feature. |
|
|
n/a |
Good Practice
:
Identify obsolete features. |
|
|
None |
4.5 Error Handling
|
Good Practice
:
Define an error handling mechanism. |
YES |
|
|
5. Do Quality Control
|
Good Practice
:
Define an internal publication and review process. |
YES |
|
|
Good Practice
:
Do a systematic and thorough review. |
YES |
|
|
Good Practice
:
Write sample code or tests. |
YES |
|
|
Good Practice
:
Write Test Assertions. |
|
no |
|
Good Practice
:
Use formal languages and define which from prose and formal languages has priority. |
YES |
|
|