All products

Write release notes with AI

Turn a change history into an account of what users will notice and what they need to do before they upgrade.

Write release notes with AI when a list of merged changes makes sense to developers but leaves customers unsure about upgrading. The release-notes skill helps an agent lead with breaking changes, organise entries by the effect on the reader and spell out the migration work that a version might require.

Suppose a configuration setting changes its name and a report now loads faster. The first item needs the old and new setting and the consequence of leaving it alone. The second needs an observable improvement, with a measurement only if the team has one. Neither needs a tour of the repository history.

What it does

  • Put an incompatible change where an upgrader will see it first.
  • Separate new features, fixes and operational changes.
  • Pair a past symptom with the behaviour users should now see.
  • Identify migration order, downtime and rollback limits.
  • Keep entries dated and tied to a specific version.

Install and use

  1. Give a writing agent the authorised change history, version and available migration notes. Supply the existing release file if it should be edited.
  2. Ask for a draft aimed at someone upgrading from the previous release, with unsupported details marked for review.
  3. Have the relevant owners check the impact and upgrade sequence before publication.

FAQ

Source

Made by Arjun Prabhulal. Original skill: release-notes, published on GitHub under the MIT licence.

View on GitHub