Documentation conventions
The original ground rules for sharing ideas quickly over the network
Crocker, S.D., "Documentation conventions", RFC 3, DOI 10.17487/RFC0003, April 1969, <https://www.rfc-editor.org/info/rfc3>.
@misc{rfc3,
series = {Request for Comments},
number = 3,
howpublished = {RFC 3},
publisher = {RFC Editor},
doi = {10.17487/RFC0003},
url = {https://www.rfc-editor.org/info/rfc3},
author = {S.D. Crocker},
title = {{Documentation conventions}},
pagetotal = 2,
year = 1969,
month = apr,
} RFC text
Network Working Group 4689
RFC-3 April 1969
Steve Crocker
UCLA
DOCUMENTATION CONVENTIONS
The Network Working Group seems to consist of Steve Carr of Utah, Jeff
Rulifson and Bill Duvall at SRI, and Steve Crocker and Gerard Deloche
at UCLA. Membership is not closed.
The Network Working Group (NWG) is concerned with the HOST software, the
strategies for using the network, and initial experiments with the network.
Documentation of the NWG's effort is through notes such as this. Notes
may be produced at any site by anybody and included in this series.
CONTENT
The content of a NWG note may be any thought, suggestion, etc. related to
the HOST software or other aspect of the network. Notes are encouraged to
be timely rather than polished. Philosophical positions without examples
or other specifics, specific suggestions or implementation techniques
without introductory or background explication, and explicit questions
without any attempted answers are all acceptable. The minimum length for
a NWG note is one sentence.
These standards (or lack of them) are stated explicitly for two reasons.
First, there is a tendency to view a written statement as ipso facto
authoritative, and we hope to promote the exchange and discussion of
considerably less than authoritative ideas. Second, there is a natural
hesitancy to publish something unpolished, and we hope to ease this
inhibition.
FORM
Every NWG note should bear the following information:
1. "Network Working Group"
"Request for Comments:" x
where x is a serial number.
Serial numbers are assigned by Bill Duvall at SRI
2. Author and affiliation
3. Date
4. Title. The title need not be unique.
DISTRIBUTION
One copy only will be sent from the author's site to"
1. Bob Kahn, BB&N
2. Larry Roberts, ARPA
3. Steve Carr, UCLA
4. Jeff Rulifson, UTAH
5. Ron Stoughton, UCSB
6. Steve Crocker, UCLA
Reproduction if desired may be handled locally.
OTHER NOTES
Two notes (1 & 2) have been written so far. These are both titled HOST
Software and are by Steve Crocker and Bill Duvall, separately.
Other notes planned are on
1. Network Timetable
2. The Philosophy of NIL
3. Specifications for NIL
4. Deeper Documentation of HOST Software.
AI ELI5
On this page
§1The Network Working Group
RFC 3 defines how the Network Working Group (NWG) will communicate. The group consists of researchers from UCLA, Stanford Research Institute and other sites concerned with HOST software and network strategies. Unlike traditional technical documentation, anyone at any site could write a note and submit it to the series, and notes were encouraged to be timely rather than polished.
A group of researchers needed to share ideas fast. The rule was simple: write your idea down, even if it is rough, and send it in.
§2Content and Style
Notes can cover any thought, suggestion or experiment related to HOST software or the network itself. Philosophical positions without examples, specific implementation techniques without background, and questions without answers are all acceptable. The minimum length for a note is a single sentence. This explicit permission to be informal and incomplete was intentional, designed to ease the natural hesitation to publish something unpolished.
You can write about any network idea, even if it is not finished or polished. Even one sentence is enough to share.
§3Format and Distribution
Every NWG note should carry standard information: the header 'Network Working Group' with a serial number (assigned by Bill Duvall at SRI), the author and affiliation, the date, and a title (which does not need to be unique). One copy is sent to designated recipients at research institutions. The note establishes that others may reproduce the document locally if needed.
Each note gets a number and header so people know where it came from. One copy is distributed to key sites, and anyone can copy it after that.