Common Sections of Specifications

Unofficial Proposal Draft,

More details about this document
This version:
http://example.com/url-this-spec-will-live-at
Issue Tracking:
GitHub
Editor:
Your Name (Your Company)

Abstract

The Abstract section provides a summary of the standard, including its purpose, scope, and key features. It’s usually a short, standalone section that appears at the beginning of the document, before the Introduction.

Status of this document

1. Introduction

The Introduction section provides an overview of the technology being specified. It should be written in a clear and concise way that is easy for the target audience to understand. It should also be consistent with the tone and style of the rest of the web standard.

It could include the following information:

The scope of a web standard is the range of topics that it covers and what is not included. The scope of a web standard can be defined in terms of the following:

2. API Sections

These sections specify the programming interface for implementing the standard using webIDL and infra.

3. Definitions

This section defines key terms and concepts used in the standard.

Conformance

Document conventions

Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

Examples in this specification are introduced with the words “for example” or are set apart from the normative text with class="example", like this:

This is an example of an informative example.

Informative notes begin with the word “Note” and are set apart from the normative text with class="note", like this:

Note, this is an informative note.

References

Normative References

[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://datatracker.ietf.org/doc/html/rfc2119