Intermediate Abbreviations #writing #documentation #style

When to Expand

6 exercises — decide when to write the full form vs. the abbreviation in RFCs, Slack messages, conference slides, user-facing articles, blog posts, and postmortems.

0 / 6 completed
When to expand: the decision framework
  • Documents (RFCs, postmortems, specs): Always expand on first use → "Full Form (ABBR)" → use abbreviation thereafter
  • Team Slack / PR comments: Skip expansion if the abbreviation is universally known to this specific audience
  • Conference slides / blog posts: Expand on first appearance — audience is always broader than a single team
  • User-facing content: Always expand on first use, even if the abbreviation appears in the UI
  • The pattern: "Full Form (ABBR)" on first occurrence — never "(ABBR) Full Form" (backwards)
1 / 6
You are writing the introduction to a technical RFC (Request for Comments) document. The document will be read by engineers across multiple teams, some of whom may not be specialists in your area. Which is the best approach for introducing the abbreviation "CRDT" on first use?