changelog-updates
Create release notes and product updates that developers actually read and care about.
What This Skill Covers
- Changelog Format: Structure and writing style that works
- What to Include: Deciding what's worth documenting
- Versioning Communication: Explaining semver to users
- Breaking Changes: Announcements that reduce friction
- Deprecation Notices: Graceful feature sunsets
- Building Anticipation: Turning releases into moments
When to Use This Skill
- Setting up a changelog for a new project
- Improving existing release communication
- Planning breaking change announcements
- Deprecating features gracefully
- Building excitement for upcoming releases
Key Principle
Release notes are developer communication, not documentation. When done well, they build trust, demonstrate momentum, and turn updates into marketing moments.
Good vs. Bad Entries
Good:
### Fixed
- Fixed timeout errors when uploading files larger than 10MB.
Uploads now stream in chunks, eliminating memory issues. (#234)
Bad:
### Fixed
- Fixed bug
Quick Wins
- Follow Keep a Changelog format
- Include issue/PR links in every entry
- Explain the "why" for breaking changes
- Add migration guides for deprecations
- Send email digests for significant releases
Related Skills
sdk-dx- SDK versioning strategydocs-as-marketing- Changelog as documentationdeveloper-community- Where to share updates