RFC Style Guide
draft-iab-styleguide-00

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Last updated 2014-02-05
Replaces draft-flanagan-style
Stream IAB
Intended RFC status (None)
Formats plain text pdf html bibtex
Stream IAB state (None)
Consensus Boilerplate Unknown
RFC Editor Note (None)
INTERNET-DRAFT                                               H. Flanagan
                                                              RFC Editor
Intended Status: Informational                                 S. Ginoza
Expires: August 9, 2014                                       RFC Editor
                                                        February 5, 2014

                            RFC Style Guide 
                        draft-iab-styleguide-00

Abstract

   This document is a summary of the style conventions and editorial
   policies that apply to the the RFC Series.  It captures the RFC
   Editor's fundamental requirements and offers guidance regarding the
   style and structure of an RFC. Guidance provided by this document
   will not be applied until published as an RFC.  Please send your
   comments about the contents of this document to <rfc-interest@rfc-
   editor.org>.

Status of this Memo

   This Internet-Draft is submitted to IETF in full conformance with the
   provisions of BCP 78 and BCP 79. 

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF), its areas, and its working groups.  Note that
   other groups may also distribute working documents as
   Internet-Drafts.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress." 

   The list of current Internet-Drafts can be accessed at
   http://www.ietf.org/1id-abstracts.html

   The list of Internet-Draft Shadow Directories can be accessed at
   http://www.ietf.org/shadow.html

Copyright and License Notice

   Copyright (c) 2013 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
 

Flanagan & Ginoza        Expires August 9, 2014                 [Page 1]
INTERNET DRAFT              RFC Style Guide             February 5, 2014

   (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. Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License. 

Table of Contents

   1.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  4
   2.  RFC Editorial Philosophy . . . . . . . . . . . . . . . . . . .  4
   3.  RFC Style Conventions  . . . . . . . . . . . . . . . . . . . .  5
     3.1.  Language . . . . . . . . . . . . . . . . . . . . . . . . .  5
     3.2.  Punctuation  . . . . . . . . . . . . . . . . . . . . . . .  6
     3.3.  Capitalization . . . . . . . . . . . . . . . . . . . . . .  6
     3.4.  Citations  . . . . . . . . . . . . . . . . . . . . . . . .  7
     3.5.  Abbreviation Rules . . . . . . . . . . . . . . . . . . . .  7
   4.  Structure of an RFC  . . . . . . . . . . . . . . . . . . . . .  7
     4.1.  First-Page Header  . . . . . . . . . . . . . . . . . . . .  8
       4.1.1.  Author/Editor  . . . . . . . . . . . . . . . . . . . .  8
       4.1.2.  Organization . . . . . . . . . . . . . . . . . . . . .  9
       4.1.3.  "ISSN: 2070-1721"  . . . . . . . . . . . . . . . . . .  9
       4.1.4.  Updates and Obsoletes  . . . . . . . . . . . . . . . .  9
     4.2.  Full Title . . . . . . . . . . . . . . . . . . . . . . . . 10
     4.3.  Abstract . . . . . . . . . . . . . . . . . . . . . . . . . 10
     4.4.  RFC Editor or Stream Manager Notes . . . . . . . . . . . . 11
     4.5.  Status of This Memo  . . . . . . . . . . . . . . . . . . . 11
     4.6.  Copyright, Licenses, and IPR Boilerplate . . . . . . . . . 11
     4.7.  Table of Contents  . . . . . . . . . . . . . . . . . . . . 11
     4.8.  Body of the Memo . . . . . . . . . . . . . . . . . . . . . 11
       4.8.1.  Introduction . . . . . . . . . . . . . . . . . . . . . 11
       4.8.2.  Requirement Words (RFC 2119) . . . . . . . . . . . . . 12
       4.8.3.  IANA Considerations Section  . . . . . . . . . . . . . 12
       4.8.4.  Security Considerations Section  . . . . . . . . . . . 13
       4.8.5.  References . . . . . . . . . . . . . . . . . . . . . . 13
         4.8.5.1.  URLs and DNS Names in RFCs . . . . . . . . . . . . 14
         4.8.5.2.  Referencing RFCs . . . . . . . . . . . . . . . . . 15
         4.8.5.3.  Referencing Internet-Drafts  . . . . . . . . . . . 15
         4.8.5.4.  Referencing Errata . . . . . . . . . . . . . . . . 16
         4.8.5.5.  Referencing Other Standards Development 
                   Organizations (SDOs) . . . . . . . . . . . . . . . 16
Show full document text