← All posts

One year of release notes

What a year of weekly releases taught us about writing changes people read.

A stack of old newspapers tied with twine.
A stack of old newspapers tied with twine.
A stack of old newspapers tied with twine.
A stack of old newspapers tied with twine.

FIG. 52

A year of issues, tied up.

Company

By D. Sample

Go to market

7

min

Sample post

Every name, figure and line here is sample copy.

We have shipped a release every week for a year. Each one came with notes, and for most of the year those notes were read by fewer people than wrote them. Here is what we changed.

Lead with what changed for the reader

Our early notes described what we did. Readers wanted to know what had changed for them. Now every note starts with the effect, then the cause, in one sentence each.

Three rules we kept

  • One change per line, so a reader can scan the list in seconds.

  • No adjectives. A faster search is faster; it does not need to be dramatically faster.

  • Every breaking change links to the page that explains it.

The changelog on this site follows those rules. Every entry in it is sample content.

Next post

Reviewing an agent's pull request →

New posts by email.

One email per post. Unsubscribe at any time. See the privacy notice.

Docs that keep up with your code.

$ docwake run --on homepage
Run complete: 9 steps, about 3 min, exit 0
Steps: Docs that keep up with your code, Five steps, every merge, Tested on 1,240 doc changes, What Docwake does not do, Fits the tools you already use, The changelog is the roadmap, Free for one repo, Asked before every trial, Run it on your next merge.

© 2026 Docwake. Sample company.

Docs that keep up with your code.

$ docwake run --on homepage
Run complete: 9 steps, about 3 min, exit 0
Steps: Docs that keep up with your code, Five steps, every merge, Tested on 1,240 doc changes, What Docwake does not do, Fits the tools you already use, The changelog is the roadmap, Free for one repo, Asked before every trial, Run it on your next merge.

© 2026 Docwake. Sample company.

Docs that keep up with your code.

$ docwake run --on homepage
Run complete: 9 steps, about 3 min, exit 0
Steps: Docs that keep up with your code, Five steps, every merge, Tested on 1,240 doc changes, What Docwake does not do, Fits the tools you already use, The changelog is the roadmap, Free for one repo, Asked before every trial, Run it on your next merge.

© 2026 Docwake. Sample company.

Docs that keep up with your code.

$ docwake run --on homepage
Run complete: 9 steps, about 3 min, exit 0
Steps: Docs that keep up with your code, Five steps, every merge, Tested on 1,240 doc changes, What Docwake does not do, Fits the tools you already use, The changelog is the roadmap, Free for one repo, Asked before every trial, Run it on your next merge.

© 2026 Docwake. Sample company.

Create a free website with Framer, the website builder loved by startups, designers and agencies.