TOC 
Internet Engineering Task ForceD. Harrington, Ed.
Internet-DraftHuawei Technologies (USA)
Intended status: InformationalApril 08, 2008
Expires: October 10, 2008 


Templates for Internet Drafts Containing MIB Modules
draft-harrington-text-mib-doc-template-05

Status of This Memo

By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of 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/ietf/1id-abstracts.txt.

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

This Internet-Draft will expire on October 10, 2008.

Abstract

This memo references three annotated templates for IETF documents that contain the definition of MIB modules. It is intended to reduce the work of the editors of such documents, making these documents more uniform and easier to read and review, thus furthering the quality of such documents and expediting their publication.



Table of Contents

1.  Introduction
2.  Overview
3.  Security Considerations
4.  IANA Considerations
5.  Contributors
6.  Normative References




 TOC 

1.  Introduction

This memo references three annotated templates for IETF documents that contain the definition of MIB modules. It is intended to reduce the work of the editors of such documents, making these more uniform and easier to read and review, thus furthering the quality of such documents and expediting their publication.



 TOC 

2.  Overview

The templates referenced by this document were developed at the request of the IETF MIB Doctors directorate, to make IETF documents that contain MIB modules more consistent. This makes it easier for a MIB Doctor to review the document. There are a number of MUSTs in the templates, especially in the advice; these usually refer to IESG requirements for internet drafts, and MIB Doctors are likely to check for these requirements.

The templates contain boilerplates that are required for IETF MIB module documents. It has been common practice for editors to use existing MIB module documents as templates. This approach has problems because boilerplates and other required elements change over time. The templates referenced by this document will be made available on an IETF web site, and occasionally updated to reflect the latest requirements. The most up-to-date revisions of the templates are available at http://www.tools.ietf.org.

The templates contain sections that describe the purpose and organization of the MIB module, and the relationship between this MIB module and other MIB modules. This makes it easier for MIB Doctors to understand the MIB module, which speeds the review process.

Editors should read RFC4181 "Guidelines for Authors and Reviewers of MIB Documents" [RFC4181] (Heard, C., “Guidelines for Authors and Reviewers of MIB Documents,” September 2005.) which describes best current practices for MIB module document editing.

The document templates do not include a template for the MIB module itself. Tools to validate MIB modules typically require that the MIB module be separated from the surrounding document. The MIB Doctors feel that the simplest approach is to develop the MIB module outside the document that contains the surrounding text, and then include the MIB module into the surrounding document written using the templates.



 TOC 

3.  Security Considerations

This memo recommends templates for editing; it has no direct impact on network security. The templates include boilerplates and associated advice for writing the Security Considerations section of an Internet Draft that documents a MIB module.



 TOC 

4.  IANA Considerations

This memo includes no request to IANA.



 TOC 

5.  Contributors

These templates are based on contributions from the MIB Doctors, especially Juergen Schoenwaelder, Dave Perkins, C.M.Heard and Randy Presuhn.



 TOC 

6. Normative References

[RFC4181] Heard, C., “Guidelines for Authors and Reviewers of MIB Documents,” BCP 111, RFC 4181, September 2005 (TXT).


 TOC 

Author's Address

  David Harrington (editor)
  Huawei Technologies (USA)
  1700 Alma Drive, Suite 100
  Plano, TX 75075
  USA
Phone:  +1 603 436 8634
EMail:  dharrington@huawei.com


 TOC 

Full Copyright Statement

Intellectual Property