Write release notes with AI
Turn verified changes into dated entries for engineers and concise notes for users. Record the effect, any migration action and what remains open.
Write release notes with AI when the people using a feature need more than the name of a merged change. The writing-changelogs skill works from evidence about what shipped. It can describe the problem someone used to encounter, the result they can now expect and any action required of them.
Imagine a file exporter that previously cut off the final rows of large reports. An engineer may want the cause and the verification result. A customer needs to know which exports were affected and whether to generate a fresh copy. Both accounts can draw on the same checked facts.
What it does
- Group related changes under the released version and date.
- Lead with an incompatible change and the migration step it requires.
- Describe removals and replacements alongside additions.
- Distinguish a known issue from work verified in the release.
- Prepare a handover that names the checks performed and what is still owed.
Install and use
- Install the maker’s technical-writer bundle or this skill with its required technical-writing companion. Supply the release evidence and existing changelog.
- Ask for a customer-facing note about a verified fix and a more detailed entry for the engineering record.
- Check the date, scope and release state before appending the entry to the history.
FAQ
Source
Made by riekelt. Original skill: writing-changelogs, published on GitHub under the MIT licence.
View on GitHub