Skip to content

Add a "Terminology" (or similar) section to the template #61

@nicopap

Description

@nicopap

A terminology section would define jargon specific to an RFC.

A terminology helps RFC editing and reading:

  • Helps the author re-use the same terms to refer to identical concepts
  • Helps the author avoid mixing different ideas, on surface identical but not interchangeable
  • Helps the author identify the concepts they are using and structure their explanation with clearly defined concepts in mind
  • Helps the author limit how many different concepts they handle in the same RFC
  • The reader can refer to that section if they forgot the meaning of a particularly specialized term
  • The reader can pay closer attention to occurrence of terms specified in the terminology section
  • It makes RFCs more accessible, as it introduces context and jargon that non-experts may not know

This is different from the "User-facing explanation" concept sub-section, in that the terminology section is for the terms used in the RFC rather than just the ones introduced into the user-facing API.

Alternative names for this section are

  • Terminology
  • Jargon
  • syllabus
  • nomenclature

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions