Guides
Release notes that people — and agents — can act on.
Short, practical guides for writing release notes, documenting breaking changes and deprecations, and versioning so upgrades go smoothly.
- 01
How to write release notes for SaaS
Explain availability and customer actions, not just what merged. Practical examples, a publishing checklist and upgrade-focused advice.
Read the guide - 02
How to write release notes for APIs
Make contract changes testable for client maintainers. Practical examples, a publishing checklist and upgrade-focused advice.
Read the guide - 03
How to write release notes for mobile apps
Distinguish store versions, server capabilities and device requirements. Practical examples, a publishing checklist and upgrade-focused advice.
Read the guide - 04
How to write release notes for open-source libraries
Give downstream maintainers an auditable path between package versions. Practical examples, a publishing checklist and upgrade-focused advice.
Read the guide - 05
How to document breaking changes
Turn an incompatibility into a bounded, reviewable migration. Practical examples, a publishing checklist and upgrade-focused advice.
Read the guide - 06
How to write deprecation notices
Communicate a replacement and removal policy before compatibility ends. Practical examples, a publishing checklist and upgrade-focused advice.
Read the guide - 07
Changelogs for AI coding agents
Publish upgrade facts agents can retrieve without guessing from marketing prose. Practical examples, a publishing checklist and upgrade-focused advice.
Read the guide - 08
Semantic versioning and changelogs
Explain compatibility decisions instead of relying on a version number alone. Practical examples, a publishing checklist and upgrade-focused advice.
Read the guide
LogPulse
Changelogs coding agents can upgrade from.
Publish versions, breaking changes, migration steps and deprecations once. People get a widget and hosted changelog; agents get a JSON feed and MCP server. Free for open source.