This document details and deepens some of the most important concepts related to conformance when designing a specification. It is a companion document of QA Specification Guidelines. It analyzes how design decisions of a specification's conformance model may affect its implementability and the interoperability of its implementations.
This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.
This document is a W3C Working Group Note. It has been produced by the Quality Assurance Working Group, which is part of the Quality Assurance Activity. It has been made available for discussion by W3C members and other interested parties. For more information about the QA Activity, please see the QA Activity statement. Translations of this document may be available.
This version features a reorganization of the content of the previous version, with a few additional sections completing the description of the various Dimensions of Variability.
Publication as a Working Group Note does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
The QA Working Group does not expect this document to become a Recommendation. Rather, after further development, review and refinement, it may be updated and maintained as a Interest Group Note.
You may email comments on this document to email@example.com, the publicly archived list of the QA Interest Group.
This document analyzes how design decisions of a specification's conformance model may affect its implementability and the interoperability of its implementations. To do so, it introduces the concept of variability - how much implementations conforming to a given specification may vary among themselves - and presents a set of well-known dimensions of variability.
Its goal is to raise awareness of the potential cost that some benign-looking decisions may have on interoperability and to provide guidance on how to avoid these pitfalls by better understanding the mechanisms induced by variability.
It completes and deepens the concepts evoked in the Specification Guidelines [SPECGL].
Like the Specification Guidelines [SPECGL], the primary audience of this document is editors and authors (henceforth referred to collectively as editors). However, it is also applicable to a broader audience including:
This document first introduces the concept of dimensions of variability, and then analyzes specific aspects related to these dimensions. Some of the dimensions are discussed in the Specification Guidelines [SPECGL] and are briefly treated here. The rest are discussed in depth. The seven dimensions are presented in a sequence from most to least independence from other design factors. After the seven dimensions, there is a section discussing how a Working Group might organize documents if variability is a factor encouraging the issuance of a package of several documents.
Many of the requirements in the Specification Guidelines [SPECGL] address ways in which a specification might allow variation among conforming implementations. For example, a specification might allow implementations to choose between one of two well-defined behaviors for a given functionality, thus two conforming implementations might vary on that aspect.
The ways in which a specification can allow variability are referred to as dimensions of variability. The QA Working Group has identified the following seven dimensions of variability:
These seven dimensions of variability are not necessarily orthogonal to one another. There are many possible associations, dependencies, and interrelationships. As a general policy, this document and the Specification Guidelines do not attempt to legislate correct or proper relationships among the dimensions of variability. Rather, they try to clarify the nature of each dimension and suggest that specifications editors make deliberate and well-documented choices.
The dimensions of variability are one of the principal concepts in the Specification Guidelines with respect to organizing, classifying and assessing the conformance characteristics of W3C specifications. The seven dimensions of variability get special attention because they are at the core of the definition of a specification's conformance model. Thus there is significant potential for negative interoperability impacts if they are handled carelessly or without careful deliberation.
As a general principle, variability complicates interoperability. In theory, interoperability is best when there are numerous identical, complete, and correct implementations. However, when compared to the alternatives, the net effect of conformance variability is not necessarily negative in all cases. For example profiles — subdivisions of the technology targeted at specific applications communities — introduce variability among implementations. Some will implement Profile ABC, some will implement Profile XYZ, and the two might not intercommunicate well if ABC and XYZ are fairly different. However, if ABC and XYZ are subsets of a large monolithic specification — too large for many implementers to tackle in total -- and if they are well targeted at actual application sectors, then subdivision by profiles may actually enhance interoperability.
Different sorts of variability have different negative and positive impacts. The principal danger is "excessive" variability - variability that goes beyond what is needed for a positive interoperability trade-off and that unnecessarily complicates the conformance model. Specification editors need to carefully consider and justify any variability allowed and its affect on conformance. This can be done by referencing project requirements and use cases and/or explicitly documenting the choices made.
It is even more important to take into account the multiplicative effect on variability created by combining several dimensions of variability. Each pair of dimensions of variability used in a specification needs to be assessed with regard to the variability it creates. The editors should document any limitations on the ways an implementation can combine dimensions. For instance, deprecated features in HTML 4.01 [HTML4] are allowed in the Transitional profile and forbidden in the Strict profile.
Note that the variability addressed by the so-called dimensions of variability is only considered with regard to conformance to a well-defined specification. As such, the changes introduced in the conformance requirements between two versions or two editions of the specification are not considered as dimensions of variability.
The most basic dimension of variability is class of product. The class of product separates the different kinds of implementations a specification may have. For instance, SVG 1.1 [SVG11] defines conformance for six classes of product: SVG document fragments, SVG stand-alone files, SVG included documents fragments, SVG generators, SVG interpreters, and SVG viewers.
Defining these classes of products is thus one of the most important steps in the design of a specification's conformance model. This section provides advice on how to identify classes of products. To do this, it introduces the design concept of specification categories.
From this categorization of specifications, a Working Group can identify the class of products that are affected by the specification. Classes of products can be generalized as either producers or consumers, or as content itself.
For example, identifying which are producers and consumers is clear for a protocol-type specification: the two parties to the dialog are the targets. For a processor-type specification, the processor is the consumer of an XML vocabulary defined in the specification. For content-type specifications, there may be one or more consumers that take the content and "play" or "read" it in some way.
The following is a list of the most common classes of products for W3C specifications:
This list does not exhaust all possibilities. Specifications may have to define their own classes of product if none of these fits.
To answer the question "what needs to conform?" it can help to first look at the nature of the specification and categorize it. Often, the scope of the specification can be determined by placing the specification in one, or possibly more, categories based on what the specification describes. This will help the Working Group decide whether they need to address a particular view of the technology, possibly including its variability, or simply declare that the specification(s) are independent of that view. Further, categorization is a first step to determining which Dimensions of Variability are likely to be in scope for the specification.
The following is a non-exhaustive list of specification categories:
Set of guidelines - describes desirable attributes of content intended for human consumption.
Examples: QA Specification Guidelines, Web Content Accessibility Guidelines.
Foundation or abstract - describes an abstraction around which several other specs will synchronize, but which is not implemented in code.
Example: XML InfoSet [INFOSET] is a foundation for various specs that have a "data model" of the usable content of an XML document. However, there is no "InfoSet API" or "InfoSet Parser" specified.
Notation/syntax - describes a language that will be expressed as an actual character stream in XML or Web content and whose semantics will be understood by other W3C-specified technologies.
Example: XPath [XPATH] is a non-XML-based notation for expressions that is used as the W3C-standard expression language for XSLT [XSLT], XPointer [XPOINTER], and XForms [XFORMS]. The specifications of those other technologies do not treat XPath as a black box, but rather impose limits, add extensions, and/or recognize the range of potential values of an XPath expression. By doing so, the other technologies require a certain level of precision in the XPath specification, including precision about its variability, to use the hooks and impose their limits.
Content/data - describes a markup language whose downstream usage is to express meaning to an end user or to applications specific to a discipline other than the Web itself.
Example: MathML [MATHML] is a markup language for the math discipline, and may be used to express mathematical ideas to a person or to math software. SVG is a language for expressing graphical ideas.
Set of events - describes a coherent set of events that software may need to raise or listen for.
Example: one part of XForms [XFORMS] is a set of form-related events.
Protocol - describes the interaction between two parties.
Example: SOAP [SOAP].
Processor - describes the behavior of a piece of software that takes well-defined inputs and operates on them to produce specified output.
Example: the XSL Transformations language [XSLT] specifies the behavior of an XSLT processor. The specification describes an XML-based style sheet language that directs the operations of a processor, but it clearly states that conformance determinations apply to the processor, not the style sheets.
Example: XML Query specifies the behavior of a processor that takes the query language and fetches data, typically arranging that data in a convenient form for XML/Web use. It allows flexibility of the storage system from which data is fetched.
APIs - describes a programmatic interface, allowing independent implementation of software that occupies the roles on either side of the interface.
Example: DOM [DOM] specifies an interface that can be implemented by a parser or other processor that intends to offer an XML document in navigable form. Other software that wishes to navigate an XML document (e.g., an XSLT processor) can be written to use the DOM interface.
Rules for deriving profiles - describes how implementers, or any parties other than the WG itself, may produce a profile for a particular situation that cannot be anticipated in complete detail at the time the WG is writing its specification.
Example: part of SMIL.
From this categorization of specifications, the Working Group can identify the class of products that are affected by the specification.
Profiles, modules and levels are three ways to subdivide a specification into related groups of conformance requirements. Because these three dimensions of variability define subsets of a technology, they share some characteristics in the way they affect conformance and interoperability.
A profile is a subset of the technology that supports a particular functional objective or a subset of a set of technologies defining how they are required to operate together (e.g., XHTML plus MathML plus SVG [X-M-S]).
Profiles can be based on hardware considerations associated with target product classes — for example, SVG Tiny is aimed at mobile phones — or they may be driven by other functional requirements of their target constituencies — for example, a graphical profile tailored for technical illustrations in aircraft maintenance manuals.
The use of profiles to divide the technology is described in the specification. Profiles may or may not be reflected and paralleled by the structure and organization of the specification.
Specifications may define individual profiles or rules for profiles or both. An individual profile defines the requirements for classes of products that conform to that profile. Rules for profiles define validity criteria for profiles themselves — i.e., if others (users, applications, or other standards) define their own profiles of the standard (called derived profiles of the specification), then rules for profiles define the constraints that those derived profiles must satisfy in order to be considered valid profiles of the specification.
For example, XHTML Modularization ([XHTML-MOD], section 3) and Synchronized Multimedia Integration Language (SMIL 2.0), [SMIL20] specifications both define rules for profiles -- what constraints must a profile meet in order to be classified as a "Host Language Profile" or an "Integration Set Profile." SMIL further defines some specific profiles, using the modularization. Separate recommendations -- XHTML Basic [XHTML-BASIC] and XHTML 1.1 [XHTML11] — define specific profiles based on the XHTML modularization.
Modules are discrete divisions or functional groupings of the technology and do not necessarily fit in a simple hierarchical structure.
Modules generally can be implemented independently of one another — e.g., audio vs. video module. That notwithstanding, it is possible for one module's definition (and therefore implementation) to have explicit dependency upon another module. It is not only possible, but also common to implement multiple modules.
Functional levels — or in common usage simply levels — are used to group functionality into nested subsets, ranging from minimal or core functionality to full or complete functionally. Level 1 is the minimum or core of the technology. Level 2 includes all of level 1 plus additional functionality. This nesting continues until level n, which consists of the entire technology.
Levels may result from progressive historical development and enrichment of the technology in a series of specifications, as in the case of CSS and DOM. Levels could also be defined explicitly in a single edition of the specification, as in the Web Content Accessibility Guidelines.
Sometimes, the nesting goal of levels is achieved through profiles. For example, SVG 1.1 [SVG11] together with SVG Mobile [Mobile [SVG-MOBILE] define three nested profiles — Tiny, Basic, Full — which are each targeted at a specific graphics hardware community (mobile phone, hand-held computer, desktop computer).
Discretionary items are defined as deliberate and explicit grants of discretion by the specification to the implementations that describe or allow optionality of behavior, functionality, parameter values, error handling, etc.
Discretionary items are often made available in specifications to give implementers of the technology the opportunity to decide from alternatives when building applications and tools. Discretionary items may be considered necessary because of environmental conditions (e.g., hardware limitations, software configuration, or external systems), locality (e.g., time zone or language), optional choices providing flexibility of implementation, dependence on other specifications, etc. By explicitly mentioning discretionary items, the specification calls attention to variability that will be of interest to both implementers and consumers of the technology. Of course, conformance testers will also want to know about such variability.
Discretionary items come in three basic variants:
The above have the following common traits: the Working Group recognized that variation is possible, they recognized that users of the technology will need to know the behavior of any given implementation, and they chose not to force uniform behavior. This can be contrasted to other types of implementation-defined behavior that the Working Group chose to leave unspecified. A common example of this is the behavior when multiple errors are present in the input.
Since explicit recognition of discretionary items has benefits for many stakeholders, it is good practice to provide an identifier for each item. Where individual choices have been identified, those can also be given names (exact
NMTOKEN values if used as parameters or attributes). This will promote proper comparison of different implementations.
The need for deprecation occurs when features defined in the specification have become outdated and are being phased out, usually in favor of a specified replacement. Discussion of deprecation appears in part 2.4.4 of the Specification Guidelines [SPECGL].
To accommodate changes in technology and information on the Web, a specification can be designed for extensibility. A specification is extensible when it provides a mechanism to allow an external party to create extensions. Extensions incorporate additional features beyond what is defined in the specification. Extensibility could apply to a particular module or profile. Additional discussion of extensibility appears in part 2.4.3 of the Specification Guidelines [SPECGL].
It is not always practical, desirable, or possible to have a monolithic specification - that is, one that presents the requirements for a technology in a single document. The Working Group may produce several documents that act collectively to specify the technology (e.g., Web Ontology Language OWL). There are all sorts of reasons for having or needing a collection or series of specifications to describe a technology. These reasons include:
In these cases, there should be a single document, called an umbrella specification that ties all the documents together. The umbrella specification serves as foundation or "Read me First" document for the entire collection or series. It can provide:
Figure 1: Umbrella specification
In this figure, the technology is composed of two modules (defining functional division of the technology), a profile (defining the requirement of implementation for a specific device) and a primer (introducing the technology and its basic concepts). An "umbrella specification" document groups them together making it a logical, usable and complete technology.
XML Schema Part 0: Primer Second Edition is
a non-normative document intended to provide an easily readable description of the XML Schema facilities, and is oriented towards quickly understanding how to create schemas using the XML Schema language.XML Schema Part 1: Structures and XML Schema Part 2: Datatypes provide the complete normative description of the XML Schema language. This primer describes the language features through numerous examples which are complemented by extensive references to the normative texts.
RDF Primer is
one document in a set of six (Primer, Concepts, Syntax, Semantics, Vocabulary, and Test Cases) intended to jointly replace the original Resource Description Framework specifications, RDF Model and Syntax (1999 Recommendation) and RDF Schema (2000 Candidate Recommendation). The Primer is designed to provide the reader with the basic knowledge required to effectively use RDF. It introduces the basic concepts of RDF and describes its XML syntax. It describes how to define RDF vocabularies using the RDF Vocabulary Description Language, and gives an overview of some deployed RDF applications. It also describes the content and purpose of other RDF specification documents.
OWL Guide and OWL Overview are other examples which approach the concept of Umbrella Specification. All documents of the OWL series refer to the Document Roadmap which gives more context.
The following QA Working Group and Interest Group participants have contributed significantly to the content of this document:
These references are informative.