Practical guide

Turn release notes into a story worth reading

Translate a shipped change into a reader’s problem, a concrete example and an honest invitation to try it.

A practical method from TellshiftBuilders and product teams whose releases are clearer to the people writing the code than to the people who might use it.4 min read

Recognize the problem?

Useful work. An unclear message.

Release notes explain what changed. Prospective users need to understand why it matters to their work. Select one demonstrable change instead of listing every fix or replacing the detail with a claim nobody can evaluate.

What you will make

You will turn one release entry into a company announcement and a builder’s explanation, with a before-and-after example. Keep the technical changelog available for readers who need more detail.

What you need

  • A release entry or manually selected change you can verify against the product.
  • A clear availability statement: released, limited test, prototype or planned.
  • One realistic example using public or fictional data, plus the person who can review it.

Step 01

Choose the change with a recognizable problem

Read the release notes and select one change whose value you can demonstrate. Write what the reader was trying to do before the release. Avoid leading with an internal component name unless the audience needs it. Keep unrelated bug fixes in the linked changelog.

“Persisted filter state” becomes “Return to the same unresolved requests without choosing the filters again.”

Step 02

Show the smallest useful before and after

Describe the old action and the new action using the same task. A short sequence, redacted screenshot or sample record can make the difference visible. Show only behavior you have checked. A mockup can explain an idea, but label it as a mockup.

Before: choose status and owner whenever you return. After: open a saved view containing those choices.

Step 03

State who can use it today

Write the release status beside the benefit. Include an important constraint where a reader would otherwise make the wrong assumption: supported input, access requirement or missing collaboration feature. If you have a prototype, invite people to examine the prototype rather than announcing general availability.

“Available in this fictional release. Views are private to their creator; shared team views are not included.”

Step 04

Write the announcement and the builder’s reasoning

Let the company draft explain the reader’s task and the new behavior. Let the personal draft explain a choice made while building it. Both should point to the same checked example. The builder’s version can name a tradeoff without turning the release into a universal lesson.

Step 05

Make the next action match the readiness

For a released feature, provide a verified location and a task to try. For a prototype, invite a walkthrough or ask about the reader’s current method. Record confusion as well as praise; repeated questions may show that the explanation needs changing.

Fictional worked example

The facts stay. The perspective changes.

The starting material

Fictional support-tool release: “Saved views retain status and owner filters. Each view is private to its creator. Shared views are not included. The behavior has been checked with sample requests.” Before: “Shipped filter-state persistence and view storage.”

The company or project voice

The personal perspective

Make it your own

Release explanation worksheet

Copy this into the tool you already use. Fill in what you know and leave unknowns visible.

Release or change:
Status and who has access:
Reader and task:
Before: [action or friction]
Now: [checked behavior]
Example or evidence:
Important limitation:
Company opening: [problem → change]
Builder opening: [decision → reason]
One verified next action:
Question to learn from:

Stay faithful to the work

The boundaries to keep.

  • The support tool and its release are fictional; this is a communication exercise, not a description of Tellshift’s features.
  • A behavior change is not proof of time saved, retention or user satisfaction. Those need separate observations.
  • This method uses release material you select yourself; it does not assume a repository connection or automatic release monitoring.

A concrete next step

Turn progress into a better conversation.

Choose one real question, inspect a work signal, edit a useful update and turn the response into a next decision.

No sign-in required. Progress stays in this browser; nothing is submitted or published. The guided workspace currently uses English. You can prepare content in English or French.

Try the builder journeyBuild in public