Changelog
CHAYNJ-log
A record of all notable changes to a product, published regularly to keep developers informed about new features, fixes, and breaking changes.
A changelog is a chronological record of what changed in each release. New features, bug fixes, improvements, deprecations, and breaking changes. It tells developers what is new and what they need to know.
For developer tools, the changelog is essential reading. Developers need to know: 'Did the API change? Do I need to update my integration? Is the bug I reported fixed?' A good changelog answers all these questions clearly.
The best changelogs are human-readable (not just git commit messages), categorized (features, fixes, breaking changes), and actionable (links to documentation for new features, migration guides for breaking changes).
Examples
A weekly changelog builds developer trust.
Every Friday, the team publishes a changelog entry. It lists 3-5 changes with clear descriptions: 'Added: Webhook retry configuration. You can now set custom retry intervals for failed webhook deliveries. See docs.' Developers subscribe to the RSS feed and read it weekly.
A changelog communicates a breaking change.
The entry is clear: 'Breaking: The /users endpoint now requires pagination. Requests without limit and offset parameters will return a 400 error. Migration guide: [link]. This change takes effect on April 1.' Developers have 30 days to update their code.
A changelog serves as marketing.
The changelog page gets 10,000 monthly visits. Developers check it to see if the product is actively maintained and improving. A product with an empty or stale changelog signals abandonment. Regular updates signal a healthy, evolving product.
In practice
Read more on the blog
Frequently asked questions
How often should a changelog be updated?
With every release. For products with continuous deployment, a weekly or biweekly summary works well. For products with versioned releases, update with each version. The key is consistency: developers should know when to expect updates.
What is the difference between a changelog and release notes?
Changelogs are concise, technical, and list all changes. Release notes are longer, more narrative, and highlight the most important changes with context and examples. Many companies publish both: a changelog for the exhaustive list and release notes for the highlights.
Related terms
A document accompanying a software release that describes new features, improvements, bug fixes, and known issues.
A dedicated website that centralizes all developer resources: documentation, API reference, SDKs, sample code, and community links.
Written resources that explain how to use a product, including guides, tutorials, API references, and troubleshooting information.
Want the complete playbook?
Picks and Shovels is the definitive guide to developer marketing. Amazon #1 bestseller with practical strategies from 30 years of marketing to developers.