Kith Spark
Sign in

Template

Release Notes Template

A release note format that closes the loop with the people who asked for each change.

In short

A release notes template that pairs a plain-language summary with the original requests behind each shipped item. Group changes by improvement, fix, and new capability, link affected feedback so requesters get notified automatically, and keep an upgrade note for anything that changes existing behavior.

Release notes are the most direct way to close the feedback loop. When a community member sees the feature they asked for ship, with their request credited, they keep contributing. When that moment is silent, they assume nobody listened.

This template keeps notes scannable for casual readers while linking each item back to its source requests. Connect those links and every requester gets an automatic lifecycle notification the moment you publish.

Template

RELEASE NOTES

Version / date: ____
Summary (one or two sentences a customer would understand):
____

NEW
- ____ (what it does and who it helps)
  Requested by: ____ (linked requests / accounts)

IMPROVED
- ____ (what changed and why it is better)
  Requested by: ____

FIXED
- ____ (the problem, stated from the user's side)

CHANGED BEHAVIOR / UPGRADE NOTES
- ____ (anything that affects existing setups, with the action to take)

THANK YOU
Contributors and accounts whose feedback shaped this release:
- ____

WHAT'S NEXT
A short pointer to the roadmap item this unblocks or sets up:
____

How to use it

  1. 1Write the summary for a customer, not for engineering. Lead with the benefit.
  2. 2Link each New and Improved item to the originating requests so requesters are notified on publish.
  3. 3Keep fixes short and framed from the user's perspective rather than the internal ticket title.
  4. 4Always fill upgrade notes when behavior changes, including the exact action a user must take.
  5. 5Credit contributors by name or account to reinforce that feedback leads to shipped work.

Frequently asked questions

How technical should release notes be?

Default to plain language that a non-technical customer understands. Put deep technical detail in upgrade notes or a linked changelog so you serve both audiences without drowning the summary.

Do I notify requesters for every line item?

Notify the people tied to the specific item that shipped, not your whole list. Linking each item to its source requests lets the notification target only the people who asked, which keeps the message relevant.

Related

Run this live in Kithspark

Templates get you started. Kithspark runs the whole loop, from the first request to the shipped release, with every contributor kept in the loop.

Sign in