Skip to main content

Glossary Entry Template

What makes a term stable enough to share?

A glossary page makes one term mean the same thing to every reader.

Apply this shape when the page job is glossary.

Frontmatter​

type: glossary
template: glossary-entry-template
template_url: /playbook/standards/templates/glossary-entry-template
loop_phase: evolution
level: entry

Shape​

  1. Name the canonical term.
  2. Define it in one line.
  3. List aliases.
  4. Say what it is not.
  5. Contrast nearby terms.
  6. Show correct usage.

Skeleton​

TERM

TERM means DEFINITION.

## Aliases

- Alias A
- Alias B

## Not This

What should not be called by this term?

## Contrast

- Nearby term - how it differs.

## Usage

Use this term when...

## Context

- [Related page](/playbook/)

Checks​

  • The definition is one sentence.
  • Aliases do not compete with the canonical term.
  • Contrasts prevent misuse.
  • Usage shows where the term belongs.

Failure Modes​

  • The page becomes an essay.
  • The definition uses another unclear term.
  • The page lists aliases without choosing the canonical name.

Context​

Questions​

What misuse should this term page prevent?

  • What is the canonical term?
  • Which aliases must not become competing names?
  • Which nearby term causes the most confusion?