Difference between revisions of "RFC Readability"

From IAB Wiki
Jump to navigation Jump to search
Line 4: Line 4:


* Very short with good examples.
* Very short with good examples.
* Introductory or Roadmap documents for complex topics


== Example RFCs and why they're good ==
== Example RFCs and why they're good ==

Revision as of 23:06, 13 January 2021

Warning: This is an early brainstorming page

Characetristics of readable RFCs

  • Very short with good examples.
  • Introductory or Roadmap documents for complex topics

Example RFCs and why they're good

IMAP: RFC3501

  • Solid examples throughout the document

Things that don't work

  • Biting off more that you can chew
    • the flip side: a gazillion tiny documents are hard to read
  • Forward references