Examples of GOOD Technical Writing: Internet RFCs

Subject: Examples of GOOD Technical Writing: Internet RFCs
From: "Ben Kovitz" <bkovitz -at- nethere -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 1 Jul 2002 09:29:59 -0700


Some sparkling examples of *great* technical writing are the RFCs
maintained by the Internet Engineering Task Force.

An RFC is a "request for comments". The Internet standards were built
by people proposing them as RFCs. As people implemented and used them,
they eventually became adopted as standards.

Most are remarkably simple and straightforward. They tell a programmer
all the technical details needed to implement them, they put them in
context, and they do so simply and readably, without fuss or fanciness.
I think of them as the ultimate examples of practical, beautiful
technical writing--the level to strive for every time I work on a
document. They have really been read and used by thousands of people to
build one of the greatest technological achievements in all of human
history.

Main repository page and index:
http://www.ietf.org/rfc.html
http://www.ietf.org/iesg/1rfc_index.txt

RFC821, the original proposal for how Internet mail gets sent
http://www.ietf.org/rfc/rfc0821.txt?number=821

RFC822, email format
http://www.ietf.org/rfc/rfc0822.txt?number=822

RFC1171, PPP (protocol for connecting to the Internet through a model)
http://www.ietf.org/rfc/rfc1171.txt?number=1171

RFC1180, TCP/IP tutorial (I haven't worked with this one, but browsing
just now it really looks good!)
http://www.ietf.org/rfc/rfc1180.txt?number=1180

RFC1341, MIME format (format for email attachments)
http://www.ietf.org/rfc/rfc1341.txt?number=1341


Ben Kovitz
Author, Practical Software Requirements: A Manual of Content & Style
http://www.amazon.com/exec/obidos/ASIN/1884777597
http://www.manning.com/Kovitz



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Save $600: Create great-looking Help files and software demos with
RoboHelp Deluxe. Get RoboHelp and RoboDemo - our new demo software - for one
low price. OR Save $100 on RoboHelp Office in June with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: Re: About Themes for Fake Names
Next by Author: The U.S. federal tax instructions
Previous by Thread: why people don't read manuals
Next by Thread: RE: Merging WebHelp projects using RoboHelp Enterprise


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads