Skip to content
Documentation

Release Notes Template

FieldValue
TypeSkill Resource
Source~/.copilot/skills/technical-writing/references/templates/release-notes.md
DescriptionNot specified

Source Content

Release Notes Template

Tells users what changed and what they must do about it. Reader-first: impact before internals.

Skeleton

# {{Product}} {{version}} — {{date, ISO format}}


{{One-line scene, then the headline: "Jill's release-day checklist just
lost three steps." One sentence: the headline change and who benefits.}}


## Breaking changes


{{Each change: what breaks, the symptom, and the fix. Link the migration
guide. If nothing breaks, say "None." — never omit the section.}}


## New


- {{Feature — what the user can now do, not what you built.}}


## Improved


- {{Change — with the before/after where measurable.}}


## Fixed


- {{Bug — the symptom users saw, with the issue link.}}

Rules for this template

  • Lead with the user’s outcome. “Deploys are 2× faster” beats “Refactored the deploy pipeline”.
  • Breaking changes always come first, even when embarrassing — especially then.
  • Version and date go in the H1; dates in ISO format (2026-07-02).
  • Format numbers with the locale helpers. Link every issue and PR — no bare URLs.
  • The useful ending, if used, is one line after Fixed — most release notes skip it; the changes speak for themselves.
  • Cast: always Jack (the path with friction) and Jill (the path that works) — see ../personas.md.
  • Reminders: story, own line per person · useful ending.
  • Format: short paragraphs · lists and tables · diagram + “what to notice”.