-
Software release notes: what they are and what to include
Software release notes tell a reader what changed in a version, who it affects and what to do. The four kinds, what to include, and a worked example.
Release notes practice5 min read
-
Bug fix release notes: how to write entries people use
Bug fix release notes work when each entry names the symptom, who was hit and the next step. Before and after rewrites, plus security and data-loss rules.
Release notes practice7 min read
-
Release notes examples for every kind of change
Release notes examples for a feature, fix, breaking change, security fix, deprecation, app store note and internal note, each with why the wording works.
Release notes practice7 min read
-
Emergency release notes: writing under real time pressure
An incident-driven release needs notes written in minutes, not days, and the usual drafting process assumes time you don't have. What to keep, what to cut.
Release notes practice5 min read
-
Internal release notes: who else needs to know what shipped
Support and sales usually learn about a launch from a confused customer. Internal release notes fix that, in a different shape from customer-facing ones.
Release notes practice5 min read
-
Release notes for mobile apps: what the limit cuts
App Store and Play Store give a few visible lines and no links. What works on a web changelog breaks on that budget, so every cut has to be deliberate.
Release notes practice5 min read
-
How to announce a new feature (without the silence)
Most feature announcements die in a channel nobody reads twice. Where to announce, what to say first, and how to reach the people who asked for it.
Release notes practice5 min read
-
Enterprise release notes: what changes for one account
Enterprise release notes for a customer on a private build must be scoped to their instance. Get the scoping wrong and you leak roadmap or confuse support.
Release notes practice5 min read
-
What is a changelog, and what goes in one?
A changelog is the dated record of what changed in a product, written for the people affected by it. What it is, is not, and where a good one lives.
Release notes practice5 min read
-
The product update email template that gets read
The email that gets read is the one sent to somebody who asked. The template, the four kinds of update email, subject lines, segmentation and consent.
Release notes practice6 min read
-
Changelog vs release notes: what is the difference?
A changelog is a running record for people looking something up. Release notes are a curated message for people deciding whether to care. How they differ.
Release notes practice5 min read
-
How to write release notes people actually read
Bug fixes and performance improvements is not a release note. Here is the question every entry has to answer, and a before and after rewrite of a real one.
Release notes practice6 min read
-
Release notes best practices worth keeping
Most best practice lists for release notes are style advice. These are the ones that change what a reader does, and three popular ones that are cargo cult.
Release notes practice6 min read
