Style Guide
The following documents form the RFC Style Guide.
- RFC 7322: “RFC Style Guide”
- Add a Table of Contents (ToCs are now required regardless of page length)
- Reorder the Acknowledgements (if applicable), Contributors (if applicable), and Authors’ Addresses so they appear in this order at the very end of the document
- Include the draft string of the Internet-Draft being referenced (see Referencing Internet-Drafts for examples)
- Include URLs for the RFC info pages in RFC references (see Referencing RFCs for examples)
- Use the English short name listed by the ISO 3166 Maintenance Agency for country names in Authors’ Addresses. See the ISO’s “Online Browsing Platform (OBP)”
- Section 4.8.6.3: Referencing STDs and BCPs (related ticket for xml2rfc v2)
- Web Portion of the Style Guide
- RFC Series Editor statement on authorship (May 2015)
- Status of This Memo Boilerplate – “Status of This Memo” text as defined by RFC 7841. All permutations of the text are listed here.
- Abbreviations List – Expansions of abbreviations (and acronyms) in RFCs
- Terms List – Table of decisions on consistent usage in RFCs
- IAB Format – IAB-specific format for RFCs in the IAB stream.
- Tips and Resources for Authors – Provides some writing tips and resources for authors
- Reference Entries for RFCs – Available in TXT and in XML (for use with xml2rfc).
- Reference Entries for STDs and BCPs – Available for the STD subseries (TXT) and the BCP subseries (TXT).
Quick Reference: New RFC Style Guide changes authors can implement now
This is a quick reference list, but it is not a replacement for the RFC Style Guide – please review the entire RFC.
The RPC is manually fixing this item, while the tools do not yet provide this functionality:
Old materials (replaced by the documents above):
- RFC Editorial Policies – A collection of policies on RFC editorial issues.
- “Instructions to RFC Authors” – A draft replacement for RFC 2223.