Tips and Resources for Authors

In addition to the guidance in the RFC Editor Style Guide (RFC 7322), we recommend:

  1. Starting with a template so you can focus on the content.
  2. Reading your document out loud, then revise. Ask someone else to read it, then revise. Repeat.As you revise, keep in mind that clear, concise language is the goal. Please see “Richard Lanham’s Lard Factor and the Paramedic Method” for information on revising verbose text.
  3. Reviewing your document for common grammar and style issues. (Below, examples are preceded by “Ex:”.)
      • Subject and verb agreement: If the subject is singular, then use a singular verb (and vice versa).
        Ex: Using the mechanisms and procedures are important. (Incorrect.)
        Using the mechanisms and procedures is important. (Correct; the subject is “using”.
      • Misplaced modifiers: When a phrase modifies the wrong noun, see if you can rephrase.
        Ex: It should accept the packet sent to the node that has an invalid value. (Incorrect.)
        It should accept the packet that was sent to the node and has an invalid value. (Correct; assuming the intended meaning is the packet, not the node, has the invalid value.)
      • Restrictive (that) and non-restrictive (which) clauses
        • that (restrictive) – introduces information that is essential to the meaning of the sentence.
          Ex: RST attacks that rely on brute force are relatively easy to detect at the TCP layer. (meaning only some RST attacks rely on brute force)
        • which (non-restrictive) – follows a comma and provides non-essential information.
          Ex: RST attacks, which rely on brute force, are relatively easy to detect at the TCP layer. (meaning all RST attacks rely on brute force)
      • Ambiguous pronouns: Check for pronouns (e.g., “it”, “they”) that might be more clear as the noun.
        Ex: For each broadcast network, a designated router describes it in its network-LSA. (Note: The “it” and “its” need clarification.)
      • Abbreviations and apostrophes: Careful of plural vs. possessive.
        Ex: the LSRs             (plural)
            the LSR's address    (singular possessive)
            the LSRs' addresses  (plural possessive)
      • Articles: definite (“the”) vs. indefinite (“a”/”an”) vs. none
        This is a tricky aspect of the English language.
        Ex: the router   (definite: a specific one)
            a router     (indefinite: a nonspecific one)
            routers      (no article: in general, or all of them)
      • Terminology and notation
        • Refer to existing RFCs on the topic.
          Ex: This document uses the terminology defined in [RFC6275].
        • Define terms or notation that are not well known.
          Ex: “|” represents foo in this document.
        • Ideally, a term appears consistently throughout the document in terms of capitalization, etc.
          Ex: white space vs. whitespace vs. ‘whitespace’ vs. Whitespace
    • Numbers: Use numerals when referring to bits, TLVs, specific values, etc. Use the spelled-out form when being used in general text.
      Ex: The field is set to 3.
      Ex: There are five options.
  4. Keeping a list of directives to provide to the RFC Editor once your document is approved for publication — for instance, if specific terms must appear in a certain way (spelling, hyphenation, capitalization, etc.), send us mail with your draft string in the subject line.

EFL Writing Resources

Merriam-Webster’s Learner’s Dictionary: This version of the dictionary gives further use examples and explanations than other versions of the dictionary. This can be specifically handy for phrasal verbs, count and noncount nouns, and participles. The site also includes quizzes and other resources.

The Online Writing Lab (OWL) at Purdue University for ESL/EFL authors: This page contains grammar and mechanics information with a specific focus on issues for authors who do not have English as their first language.

A Practical English Grammar, Fourth Edition: This comprehensive reference guide allows easy index searching. It contains a number of helpful lists related to verb subcategorization, diagrams related to the verb use and sequence of tenses, and the ability to search by word or topic.

A.K. Thomson and A.V. Martinent, Oxford University Press 1960, 1969, 1980, 1986, ISBN: 0 19 431342 5 (paperback)

Other Writing Resources

Merriam Webster’s Dictionary

Chicago Manual of Style

The Elements of Style

Advanced Search