Back to the notebook

Field guide · Issue 01

Write release notes people can use.

A practical reference for turning a finished mobile build into a clear, considerate update — without burying the useful bit in internal language.

A FIELD GUIDE, NOT A SCRIPT

There is no single right length, format or voice for every app update. There is, however, a reliable aim: leave a person better able to understand what changed in their own routine. The sections below offer a compact way to get there.

Start with the moment, not the mechanism.

Before writing, picture the moment in which someone notices the change. Are they resuming a task? Checking something sensitive? Looking for an option that has moved? That moment is the centre of the note. The technical mechanism can inform the wording, but it rarely needs to lead it.

A useful input question: “What will a person be able to do, notice or avoid after this update that was difficult before?”

Ask a product partner for the intended outcome, an engineer for essential conditions, a designer for visible changes, and support for the likely first question. Each answer should fit in one sentence. If it does not, the team may still be describing the work rather than its outcome.

Use five lines to find the shape.

Draft the following in plain language. You may collapse them into one paragraph later. Their job is to make sure no important idea is invisible while the note is still being written.

1. Headline: a recognisable idea for the release

2. Change: the visible new or improved behaviour

3. Value: why that difference matters in a real task

4. Action: what to try, check or do next — if anything

5. Condition: the key limit, timing or requirement

Example: a steadier return to saved items

Headline: Your saved items, ready when you are.
Change: Saved items should now appear more reliably when you return to the app.
Value: This makes it easier to continue where you left off after switching tasks.
Action: No action is needed.
Condition: The improvement arrives with version 4.8 and may take a short time to settle after updating.

Put qualifiers near the promise.

A qualifier is not fine print. If a feature arrives gradually, needs a newer operating system, or only applies to a particular account type, say so in the same thought as the benefit. Someone should not have to discover the limit after trying to use the feature.

  • Availability: “This begins rolling out this week, so it may not appear for everyone at once.”
  • Compatibility: “Available on phones running iOS 17 or later.”
  • Scope: “This improves new shared lists; existing lists are unchanged.”
  • Choice: “You can turn this on from Settings when you are ready.”

Avoid vague reassurance such as “minor fixes” when a recognisable workflow has been affected. Equally, do not give a change a bigger claim than the evidence supports. Precise and modest is usually more trustworthy than grand and blurry.

Review as if the note is the only context.

People may encounter release notes in a narrow store panel, during an interrupted day, or through a screen reader. Read the note out loud. Does the first sentence explain itself? Is the person-facing effect before the internal method? Could a translator preserve the meaning without untangling a joke?

Two people reviewing mobile app designs together on a table
  1. Read the headline and opening sentence without the build ticket nearby.
  2. Ask whether a person who cannot see the feature yet will understand the rollout status.
  3. Check every setting name, device condition and date against the released build.
  4. Give the final wording to support before publication.

Useful restraint: if an item only matters to internal tracing, keep it in the internal changelog. A public release note earns its place by helping someone outside the team.

Keep a small reference library.

Save good notes alongside the reason they worked. Record phrases that triggered avoidable questions, qualifiers that gave people clarity, and copy that needed correction after shipping. Over time, that library becomes a shared editorial memory.

What to keep

  • A before-and-after pair where the public wording became clearer.
  • A record of familiar product terms and their preferred spelling.
  • A short list of recurring availability statements, reviewed each release.
  • Questions from support that revealed a missing line in the note.

Return to the release-note checklist when you need a fast pre-flight, or use the local sketch pad to shape a first version in your browser.