Dark mode is here. Turn it on in Settings > Appearance, or let your system preference decide. Text and controls also have stronger contrast, so everything is easier to read.
Guide
The complete guide to product changelogs
A product changelog is a running record of what you ship: new features, improvements and fixes, written for the people who use your product. Here's how to write one people read, keep it going and get it in front of customers.
On this page
A changelog is the simplest proof that your product is alive and that customer feedback leads somewhere. It only earns that trust when it's written for customers, kept on a steady rhythm and delivered where they'll see it.
The best teams treat the changelog as the last step of a loop: collect feedback, ship the work, announce it and tell the people who asked. This guide covers the writing, the cadence, the distribution and the tools.
What a changelog is and why it matters
A product changelog lists the meaningful changes you ship, newest first. Each entry says what changed and why it matters to the reader. It's a communication tool first and a version history second. It overlaps with two related formats:
| Format | What it is | Typical reader |
|---|---|---|
| Changelog | A running, dated list of everything notable you ship | Customers who want to keep up |
| Release notes | The details of one release or version | Admins and technical users |
| Update announcement | One larger story about a single launch | Every customer, by email or in the product |
A maintained changelog closes the feedback loop. Customers see their requests turn into shipped work, so they keep giving feedback, and you get fewer "is this still being worked on?" tickets.
Anatomy of a great changelog entry
- A title that names the benefit. "Export any board to CSV" beats "Export improvements".
- A date, plus a version number if customers install your software.
- A category such as New, Improved or Fixed, so readers can scan.
- One to three sentences on what customers can now do and why it matters.
- A screenshot or short clip for anything visual.
- A link to the docs when the change needs more explanation.
- Credit to the requests it answers, so the people who asked see the connection.
Write in plain language, in the active voice, from the customer's side:
| Instead of | Write |
|---|---|
| Refactored the export service | Exports now finish in seconds, even for large boards |
| Added SSO support | Your team can sign in with your company's identity provider |
| Various bug fixes | Fixed: comments no longer disappear after you edit them |
The Keep a Changelog convention groups changes as Added, Changed, Deprecated, Removed, Fixed and Security, alongside semantic versioning. It suits developer-facing products. Customer-facing changelogs usually work better with fewer, friendlier categories.
Public vs internal changelogs
A public changelog faces customers. It highlights features and improvements in plain language and skips internal refactors. An internal changelog faces your team. It records every change, including infrastructure work and breaking changes, with enough detail to debug a regression later.
Most teams keep both. The internal log is the source of truth, and the public changelog is the curated view. Deciding what goes where is a writing question, not a tooling one: if a customer wouldn't notice or care, it stays internal.
Choosing a cadence
Consistency beats frequency. A changelog updated every two weeks builds more trust than one that goes quiet for months, then posts fifty entries at once.
- Pick a rhythm you can keep: every release, every week or every two weeks.
- Publish small things too. A steady stream of improvements and fixes shows the product is moving.
- Batch the trivial. Roll minor fixes into one entry so the log stays readable.
- Write entries as you ship and schedule them, so publishing day isn't a scramble.
Distributing your changelog
Most customers won't visit your changelog page on their own. Bring the updates to them:
| Channel | Reaches |
|---|---|
| In-app widget | Active users while they work, with a badge for unread updates |
| Customers who aren't in the product this week | |
| RSS feed | Power users, and tools that follow feeds |
| The original request | The customers who asked for the change |
| Social and community | Prospects and the wider market |
The most valuable message goes to the people who asked for the change. "You asked for this, and it's live" turns a requester into an advocate.
Changelog tools
For developer tools, a CHANGELOG.md file in your repository is often enough. Products with non-technical customers need more: a hosted page, an in-app widget, email and RSS, without custom code.
Standalone changelog tools handle the publishing. Platforms that also hold your feedback and roadmap go a step further: they know who asked for each change, so announcing it and closing the loop are the same action.
Changelogs in Quackback
Announce what shipped to everyone who asked
Link an entry to the requests it ships, and everyone following them hears about it. The same entry appears on your changelog page and in your widget. This is a demo portal: open an entry.
Drafts now save on the device and sync the moment you are back online.
Connect your workspace to Slack to hear about new feedback, votes and status changes as they happen. Send each board to its own channel so the right team sees it.
Save your layout, logo and payment terms once and reuse them on every invoice.
Common questions
What is a product changelog?
A product changelog is a dated, curated record of the meaningful changes you ship: new features, improvements, fixes and removals. Each entry tells customers what changed and why it matters to them.
How do you write a good changelog entry?
Lead with the benefit, not the implementation. Give it a clear title, a category such as New, Improved or Fixed, and one to three plain sentences on what customers can now do. Add a screenshot where it helps and a link to documentation when the change needs more explanation.
What is the difference between a public and internal changelog?
A public changelog faces customers and highlights features and improvements in plain language. An internal changelog faces your team and records every change, including infrastructure work, with enough detail to debug later. Most teams keep both.
How often should you publish a changelog?
Consistency beats frequency. Pick a rhythm your team can keep, such as every release, every week or every two weeks. Publish small improvements too, and batch trivial fixes into one entry.
How do you distribute a changelog?
Bring updates to where customers already are: an in-app widget for active users, email for those who aren't in the product, and an RSS feed for people and tools that follow feeds. Tell the customers who asked for each change directly.
Have another question? Talk to the team.