Docket

CHANGELOGS

How to write patch notes

Patch notes and release notes read like the same thing until you write one, and the differences are exactly where most patch notes go wrong.

6 MIN READ Last updated 23 August 2026

Patch notes are the record of a small, frequent update, usually numbered, read by people who already use the product and want to know exactly what moved. That audience is more invested than a release note's, so more detail is welcome.

This page is one part of a larger guide. For the whole subject in one place, see changelogs and release notes.

How are patch notes different from release notes?

Frequency and audience. Release notes arrive with a bigger, less frequent release, written to be skimmed in seconds by someone not that invested. Patch notes arrive more often, cover smaller changes, and are read by people who already know the product well enough to notice a single line moved.

That difference changes how much detail earns its place. A general-audience release note loses people the moment it gets specific about mechanics. A patch note loses an invested reader the moment it gets vague, because vagueness reads as something being hidden. How to write release notes covers the general-audience craft in full; this page is the more frequent, more detailed sibling.

Live, actively used software with a community that discusses every change tends to publish patches often and in detail. A slower-moving product can get away with a lighter touch. Either way, the habit is the same: name the specific thing that changed.

What belongs in a patch note that would be noise in a release note?

More of the small stuff. A release note is right to leave out a one-line tuning change or a fix only a fraction of users would notice. A patch note should include it anyway: the test is not "is this important" but "would my most attentive reader recognise this."

That does not mean everything belongs. Internal refactors, dependency bumps with no visible effect, and test coverage still have no place in either document. If nothing changed that a user could see, click, or notice, it is not a patch note entry.

How do you describe a fix without making the product sound broken?

Frame every change as something the reader is gaining, never as an apology for something broken. Not "fixed a bug where the export failed," but "exports now complete reliably." The nuance is in how you handle a problem the reader could actually have seen.

When the reader could have noticed the problem themselves, an error message, a dead button, a frozen screen, name it gently so they recognise their own experience. "If you ever saw an export stop partway through, this release resolves that" fixes the thing and lets the person who hit it feel heard, without the word "bug."

When the problem was invisible, memory use, background processing, internal reliability nobody could have seen, use pure improvement language with no hint anything was wrong. Naming an invisible problem does not resolve doubt, it plants one. "Improved memory efficiency during background sync" is complete on its own; it does not need "which used to leak" attached.

SituationWeak phrasingImproved phrasing
Visible: exports stopped partway throughFixed a bug where large exports could fail.If you ever saw an export stop partway through, this release resolves that. Exports now complete reliably on large boards.
Invisible: memory use crept up during syncFixed a memory leak in the background sync worker.Improved memory efficiency during background sync.
Visible: a button stopped respondingFixed the export button not responding to clicks.The export button now responds every time. If it ever seemed unresponsive, that is what this addresses.
Invisible: an internal race conditionFixed a race condition in the job queue.Refined how background jobs are processed, for more consistent results.

The weak column is not wrong, exactly. It is honest and specific, already ahead of "various bug fixes." It just names the problem in the code's terms, and apologises where the improved version reports progress. Ten items in the weak style read as a product broken in ten places; the same ten in the improved style read as one getting steadily better, and the underlying work is identical.

How does patch numbering relate to versioning?

Most products attach a patch note to a version number, and the number should mean something rather than just count upward. Under a MAJOR.MINOR.PATCH scheme, a note that only fixes things bumps the last number: 1.4.1 to 1.4.2. Other products number patches sequentially instead, Patch 12, Patch 13, a plain count of patches shipped. Either way, what matters is that the number is consistent, so a reader can say "we're two patches behind" and be understood.

Patch 1.4.2, 22 August 2026

Fixed
- Large board exports now complete reliably every time.
- The search bar no longer loses focus after a filter.

Known issues
- CSV exports over 50,000 rows may time out on slow
  connections. A fix is planned for the next patch.

That shape, a version, a date, entries grouped by kind, each line naming the specific thing that changed, scales down to a two-line patch and up to a much longer one without changing structure. For a ready-made structure to start from, see release notes templates.

Your own support centre, in your own repository

One payment, no subscription, unlimited products.

How do you handle a patch that changes behaviour people had learned to rely on?

Say so plainly, and put it where an invested reader will not miss it. This is the one place a patch note should sound less like an improvement and more like a heads-up: a reader who built a habit around the old behaviour needs to know before they hit it, not after.

Three things make that land well: state what used to happen and what happens now, in that order; give the reason in one sentence if it reassures rather than sounds defensive, "changed to prevent accidental duplicate submissions" reads as a decision, not a regression; and say if there is a way to get the old behaviour back, a setting or a flag.

Strictly, that kind of change is not really a patch in the semantic-versioning sense, since that scheme reserves the biggest version number for exactly this. Whether or not you follow the convention to the letter, do not bury it inside a list of fixes where it reads as equally minor. Give it its own line, near the top.

Should patch notes include a known-issues section?

Sometimes, depending on whether it helps the reader or just covers you. A known-issues section earns its place when it saves someone time: a limitation that is easy to hit, has a workaround, or has a fix already planned. "Large CSV exports may time out, a fix is coming in the next patch" stops a duplicate report and shows the issue is being tracked.

It stops earning its place once it becomes a permanent list of vague caveats nobody reads, or a place to pre-emptively excuse problems nobody has reported. An issue sitting there for months with no progress is quietly admitting the product does not get fixed. Keep the list short and current, or leave it out and handle limitations through support instead.

Frequently asked questions

How often should patch notes be published?

As often as something changes that an attentive user would notice, no more for the sake of a schedule. A note with nothing real in it teaches readers to stop opening the next one.

Do patch notes need their own version number, separate from the main release?

Not necessarily. Many products simply bump the patch part of their existing version number, keeping one numbering scheme across every kind of update.

Should a patch note ever say "no user-facing changes"?

Yes, if your product publishes a note for every patch regardless of content. One honest sentence beats inventing filler to make a quiet patch look bigger than it was.

Is it ever right to skip a patch note entirely?

Yes, for a change with no visible effect: an internal refactor, a dependency bump, a test-only change. If your product does not note every version number, these releases simply get none.

Who should decide whether a change counts as visible or invisible?

Whoever is closest to how the product is used, often support rather than the engineer who made the change. The engineer knows the mechanism; the person who reads bug reports knows what a user would have noticed.