Write release notes
Turns merged pull requests or commits into release notes for a chosen audience, grouped by impact and written as outcomes without internal jargon. Use when shipping a version.
Commit logs describe what engineers did; release notes describe what changed for the reader. Readers scan for three things: does anything break or need action from me, what can I now do that I could not before, and was the problem I reported fixed. Notes that list refactors, ticket numbers and component names bury those answers. Notes that inflate a minor fix or guess at a change's effect mislead people.
Write release notesOnly if [VERSION] is given: for for from these changes:
- Classify every change: breaking or action required, new, improved, fixed, security, deprecated, or internal (no effect the reader can notice).
- Drop internal changes: refactors, CI, test, tooling and dependency bumps, unless they change behaviour, performance the reader would notice, supported versions, or fix a security issue.
- Merge changes that are parts of one outcome into a single item.
- Rewrite each item as one sentence about the outcome for the reader, in their words: "You can now export invoices as PDF" rather than "Add PdfRenderer to InvoiceService". Fixes say what used to go wrong. For developers, name the public API, endpoint, flag or config key affected, and nothing more internal than that. For admins, include configuration, migration, permission, compatibility and deployment impact.
- Every breaking change or required action gets what breaks, who is affected and the exact step to take, before anything else.
- When a change's user-facing effect is unclear from the input, do not guess: put it under "Questions".
- No internal details: no class, file or component names, ticket numbers, author names or architecture terms, except public API names for developers.
- Do not overstate: no "blazing fast", "major overhaul" or invented numbers. Use a performance figure only if the input gives it.
- Keep each item to one sentence. Order sections by impact on the reader, and items within a section by how many readers they affect.
- Omit empty sections.
Release notes
The notes, ready to paste: a ### heading with the version if given, an optional one-sentence highlight, then #### sections in this order: Action required, New, Improved, Fixed, Security, Deprecated. Each item is a bullet.
Left out
Bullets: each dropped change and why it was left out (internal, merged into another item).
Questions
Bullets: changes whose user-facing effect you could not determine. Or "None".
1 required value still a placeholder; the assistant will ask for it.
details
- kind
- Prompt: a task you run by name to get one finished thing back
- domain
- Software engineering
- category
- Documentation
- level
- Beginner
- made for
- Software engineer, Product manager, Open-source maintainer, Technical writer
- risk
- read-only
- version
- v1.0.0 · incubating
- reviewed
- 2026-10-02
- works in
- Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Antigravity, OpenCode, Windsurf, Zed, Continue, AGENTS.md, ChatGPT, claude.ai
use in
npx @hermes-hq/hodios install write-release-notes --target claude-codenpx skills add hermes-hq/hodios-dist --skill write-release-notes -a claude-codeclaude plugin marketplace add hermes-hq/hodios-distclaude plugin install hodios-software-engineering@hodiosThe plugin brings every entry in this domain at once.
more in documentation
All of DocumentationDocument a public API
Writes reference docs for a module's exported functions, classes or endpoints in the native doc-comment format, covering real behaviour, errors and edge cases. Use before a release.
document-public-apiWrite a changelog entry
Turns the commits and pull requests in a release range into a user-facing changelog entry in Keep a Changelog format, with breaking changes first. Use when cutting a release.
write-changelogWrite a migration guide
Writes an upgrade guide for a breaking release that lists each breaking change with how to find affected code, before-and-after examples and a way to verify. Use when shipping a major version.
write-migration-guideWrite a README
Writes or improves a project README from what the code actually does, with an install and quick start that work when copied. Use for a new project or a README that has drifted.
write-readmeAudit a documentation set
Audits documentation for accuracy against the code, gaps in the user journey, stale pages, duplication and findability, and returns a prioritised fix list. Use before a docs overhaul or release.
audit-documentationOpen-source maintainer
Acts as an experienced open-source maintainer who protects project scope, writes welcoming but firm replies, reviews contributions and keeps releases sustainable.
open-source-maintainer