Write release notes

What it asks you for

What changedrequired

Commits, PR titles, or a summary.

Who reads this

So the vocabulary fits.

What it tells the AI to do

Turn these changes into release notes for {{ audience | default("users") }}:

{{ changes }}

Order by what it does to the reader, not by when it merged. Breaking changes
first, each with the migration step; then what is new; then fixes; then
anything internal, or nothing at all if they would not notice.

Write each entry in the reader's vocabulary. "Chats load faster on slow
connections" is a release note. "Refactored the message hydration path" is a
commit message that wandered into one.

An entry that cannot be stated as something the reader can now do, or no longer
has to work around, does not belong in the notes.

Why this works

Release notes fail by being ordered the way the work happened rather than by what it does to the reader. Breaking changes come first with their migration step, and every entry has to be stateable as something the reader can now do or no longer has to work around. An entry that cannot be phrased that way is a commit message that wandered into the notes.

• release
• changelog
• notes
• shipping

More writing skills

• Translate a documentTranslate a document while preserving its structure.
• Write a first draftTurn a brief into a structured first draft in your voice.
• Rewrite and polishTighten existing text without changing what it says.
• ProofreadCatch grammar, spelling, and consistency errors without rewriting.
• Summarize thisCondense a document, thread, or recording into what actually matters.
• Draft a replyTurn a message you received into a reply you can send.