Difference between revisions of "RFC Readability"

From IAB Wiki
Jump to navigation Jump to search
Line 1: Line 1:
Warning: This is an early brainstorming page
Warning: This is an early brainstorming page


== Characetristics of readable RFCs ==
== Characteristics of readable RFCs ==


* Very short with good examples.
* Very short with good examples.

Revision as of 00:26, 14 January 2021

Warning: This is an early brainstorming page

Characteristics of readable RFCs

  • Very short with good examples.
  • Introductory, Architecture, 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