This memo defines a list of often called "ID-NITS" that need to be checked before an Internet-Draft will be accepted for IESG consideration.
May 12, 2009
2. Form nits
2.2. Required sections - all I-Ds
2.3. Sometimes-required sections
3. Content issues
4. Protocol Issues
5. Change Log
6. Normative References
§ Author's Address
All Internet Drafts which are offered to an AD or the IESG with a request for publication as RFC must conform to the following requirements or they will be returned to the author(s)/editor(s) for revision.
The WG Chairs are responsible for having this list checked before submission to the ADs.
A handy tool (awk script) to check most of the formatting nits (as in Sections 2.1 and 2.2 below) is available at http://tools.ietf.org/tools/idnits/, courtesy of Henrik Levkowetz.
Another set of handy tools is available at the IETF TOOLS pages.
Checking for content related issues (as in Sections 2.3, 3, and 4 below) needs a human eye.
The content issues have to be checked early in the development of documents, being technically integral. The WG Chairs are responsible for this too.
The ADs will not accept the document and so will not put it on the IESG agenda if this check has not been done.
Responsibility for all checking is with the authors in the case of an individual submission.
This document only talks about "finished" Internet-Drafts. That is those I-Ds for which the IESG gets a request for publication. However, it is strongly RECOMMENDED to follow these rules/guidelines for documents that go to WG Last Call as well.
Guidelines for all Internet-Drafts are in Guidelines to Authors of Internet-Drafts, and are not repeated here.
As a suggestion for productivity improvement, it is strongly RECOMMENDED to use XML2RFC [RFC2629] (Rose, M., “Writing I-Ds and RFCs using XML,” June 1999.) as source files for generating an Internet-Draft. (There is even an online xml2rfctool to generate the nroff and Internet-Draft .txt files). That tool automatically takes care of most of the formatting, administrative and bureaucratic rules.
There is a rumor that the tool will soon also take care of all the content
In principle, the RFC-Editor can take care of a few small formatting errors. And if there are only a few, then they will do so. However, if many errors exist, the document will be returned to the author(s)/editor(s)/WG for fixes. In any event, please realize that not following the formatting rules will most probably delay publication and does consume time that can be spend on other work.
See "RFC Style Guide" https://tools.ietf.org/html/rfc7322 for details and further rules. Here is a checklist of formatting problems rules that often get neglected:
The following are REQUIRED sections in all Internet-Drafts:
Network Working Group <yourname> Internet-Draft <your affiliation> Obsoletes: xxxx (if approved) August 29, 2006 Updates: yyyy, zzzz (if approved) Intended status: Best Current Practice Expires: February 21, 2007 ... Abstract This document describes ..... It obsoletes RFC xxxx and updates RFC yyyy and RFC zzzz