RFC Style Guide
RFC 7322
| Document | Type |
RFC - Informational
(September 2014; Errata)
Updated by RFC 7997
Obsoletes RFC 2223
Was draft-iab-styleguide (individual)
|
|
|---|---|---|---|
| Authors | RFC Editor , Heather Flanagan | ||
| Last updated | 2017-08-03 | ||
| Replaces | draft-flanagan-style | ||
| Stream | IAB | ||
| Formats | plain text html pdf htmlized bibtex | ||
| Stream | IAB state | Published RFC | |
| Consensus Boilerplate | Yes | ||
| RFC Editor Note | (None) | ||
Internet Architecture Board (IAB) H. Flanagan
Request for Comments: 7322 S. Ginoza
Obsoletes: 2223 RFC Editor
Category: Informational September 2014
ISSN: 2070-1721
RFC Style Guide
Abstract
This document describes the fundamental and unique style conventions
and editorial policies currently in use for the RFC Series. It
captures the RFC Editor's basic requirements and offers guidance
regarding the style and structure of an RFC. Additional guidance is
captured on a website that reflects the experimental nature of that
guidance and prepares it for future inclusion in the RFC Style Guide.
This document obsoletes RFC 2223, "Instructions to RFC Authors".
Status of This Memo
This document is not an Internet Standards Track specification; it is
published for informational purposes.
This document is a product of the Internet Architecture Board (IAB)
and represents information that the IAB has deemed valuable to
provide for permanent record. It represents the consensus of the
Internet Architecture Board (IAB). Documents approved for
publication by the IAB are not a candidate for any level of Internet
Standard; see Section 2 of RFC 5741.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
http://www.rfc-editor.org/info/rfc7322.
Copyright Notice
Copyright (c) 2014 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document.
Flanagan & Ginoza Informational [Page 1]
RFC 7322 RFC Style Guide September 2014
Table of Contents
1. Introduction ....................................................3
2. RFC Editor's Philosophy .........................................4
3. RFC Style Conventions ...........................................5
3.1. Language ...................................................5
3.2. Punctuation ................................................5
3.3. DNS Names and URIs .........................................6
3.4. Capitalization .............................................6
3.5. Citations ..................................................6
3.6. Abbreviation Rules .........................................7
4. Structure of an RFC .............................................8
4.1. First-Page Header ..........................................9
4.1.1. Author/Editor .......................................9
4.1.2. Organization ........................................9
4.1.3. "ISSN: 2070-1721" ..................................10
4.1.4. Updates and Obsoletes ..............................10
4.2. Full Title ................................................10
4.3. Abstract Section ..........................................11
4.4. RFC Editor or Stream Notes Section ........................11
4.5. Status of This Memo Section ...............................11
4.6. Copyright, Licenses, and IPR Boilerplate Section ..........11
4.7. Table of Contents Section .................................11
4.8. Body of the Memo .........................................12
4.8.1. Introduction Section ...............................12
4.8.2. Requirement Language Section .......................12
4.8.3. IANA Considerations Section ........................13
4.8.4. Internationalization Considerations Section ........13
4.8.5. Security Considerations Section ....................13
4.8.6. References Section .................................14
4.8.6.1. URIs in RFCs ..............................15
4.8.6.2. Referencing RFCs ..........................15
4.8.6.3. Referencing STDs and BCPs .................16
4.8.6.4. Referencing Internet-Drafts ...............17
4.8.6.5. Referencing Errata ........................18
4.8.6.6. Referencing Other Standards Development
Organizations (SDOs) ......................18
4.9. Appendices Section ........................................19
4.10. Acknowledgements Section .................................19
4.11. Contributors Section .....................................19
4.12. "Author's Address" or "Authors' Addresses" Section .......20
Show full document text