Skip to content
Skills Library
Programming · Writing

technical-writer-release-notes

/technical-writer-release-notes

Authors release notes / changelog entries for a version — grouped as Added / Changed / Fixed / Deprecated / Removed / Security, with breaking-change callouts and upgrade notes. Pulled by the `technical-writer` specialist. TRIGGER: "write the release notes for v2.4", "draft the changelog entry for this release", "document what's new in version Y", "write the upgrade notes for the breaking change in X", "summarize this PR set into release notes". DO NOT TRIGGER for: marketing launch announcements (use `marketing-launch-plan`), blog posts about a release (use `copywriter-long-form`), API referenc

Repository
guild ↗
Licence
MIT
Last repository change
26.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
2
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 26.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Authors release notes / changelog entries for a version — grouped as Added / Changed / Fixed / Deprecated / Removed / Security, with breaking-change callouts and upgrade notes. Pulled by the `technical-writer` specialist. TRIGGER: "write the release notes for v2.4", "draft the changelog entry for this release", "document what's new in version Y", "write the upgrade notes for the breaking change in X", "summarize this PR set into release notes". DO NOT TRIGGER for: marketing launch announcements (use `marketing-launch-plan`), blog posts about a release (use `copywriter-long-form`), API referenc

Triggers from the description

write the release notes for v2.4draft the changelog entry for this releasedocument whatwrite the upgrade notes for the breaking change in Xsummarize this PR set into release notes
Original author description

Authors release notes / changelog entries for a version — grouped as Added / Changed / Fixed / Deprecated / Removed / Security, with breaking-change callouts and upgrade notes. Pulled by the `technical-writer` specialist. TRIGGER: "write the release notes for v2.4", "draft the changelog entry for this release", "document what's new in version Y", "write the upgrade notes for the breaking change in X", "summarize this PR set into release notes". DO NOT TRIGGER for: marketing launch announcements (use `marketing-launch-plan`), blog posts about a release (use `copywriter-long-form`), API referenc

How it works

  1. What you do
  2. Output shape
  3. Anti-patterns
  4. Handoff
Original SKILL.md headings · 54 lines, 360 words
SKILL.md preview
---
name: technical-writer-release-notes
description: Authors release notes / changelog entries for a version — grouped as Added / Changed / Fixed / Deprecated / Removed / Security, with breaking-change callouts and upgrade notes. Pulled by the `technical-writer` specialist. TRIGGER: "write the release notes for v2.4", "draft the changelog entry for this release", "document what's new in version Y", "write the upgrade notes for the breaking change in X", "summarize this PR set into release notes". DO NOT TRIGGER for: marketing launch announcements (use `marketing-launch-plan`), blog posts about a release (use `copywriter-long-form`), API reference updates (use `technical-writer-api-docs`), user manual updates (use `technical-writer-user-manual`), tutorial updates (use `technical-writer-tutorial`), social post announcing the release (social-media-platform-post).
when_to_use: The parent `technical-writer` specialist pulls this skill when the task is producing a changelog or release-notes page for a specific version. Also fires on explicit user request.
type: specialist
---

# technical-writer-release-notes

Match commit/PR facts exactly, don't rewrite adjacent versions' notes, evidence = a changelog a user on the previous version can upgrade from without surprise.

## What you do

Turn a set of merged changes into a version entry the reader can skim, filter, and act on. Release notes are for humans upgrading — not for marketing, not for internal brag-lists.

- Group entries by type — Added, Changed, Fixed, Deprecated, Removed, Security — in that order. Keep-a-Changelog conventions are fine.
- One bullet per change. Start with a verb, name the surface, link to PR/issue, link to docs if it's a new feature.
- Breaking changes get a top-of-release callout with migration steps or a pointer to a migration guide.
- Deprecations state the replacement and the removal target version.
- Security fixes get a line even when embargoed — credit reporters if agreed.
- Pull from merged PRs, conventional-commit titles, and the milestone. Ask the owning specialist to verify ambiguous entries.

## Output shape

Markdown appended to `CHANGELOG.md` or a version page:

```
## [2.4.0] - 2026-04-24

### Breaking changes
- `POST /orders` now requires `idempotencyKey` header. [migration](./migrations/2.4.md)

### Added
- Webhook retries with exponential backoff. (#1234)

### Changed
- Default page size raised from 25 to 50. (#1240)

### Fixed
- Fixed crash when exporting empty workspace. (#1241)

### Deprecated
- `GET /v1/users/me`; use `GET /v1/session` (removal in 3.0).
```

Store at `.guild/runs/<run-id>/docs/release-<version>.md` if tracked; otherwise patch `CHANGELOG.md` or the release-notes page.

## Anti-patterns

- Internal jargon: "refactored the WidgetFooBar factory" — rewrite for the user-visible outcome or drop it.
- Missing breaking-change callouts — upgrade bricks happen here.
- Marketing speak: "we're thrilled to announce" belongs in the launch post, not the changelog.
- Copy-pasting commit messages verbatim (`fix: wtf`).
- No PR/issue links — the reader can't dig in when a line affects them.
- One-line "various fixes and improvements" — users cannot plan upgrades against vapor.

## Handoff

Return the release-notes path/diff to the invoking `technical-writer` specialist. If a change warrants more coverage, chain into `copywriter-long-form` (blog post) or `marketing-launch-plan` (launch). For social teasers, hand off to `social-media-platform-post`. This skill does not dispatch.
Files in this package (2)
  • SKILL.md 3 KB
  • evals.json 1 KB

Versions

The database has no other skills named technical-writer-release-notes.

Database snapshot: 13.11.2026 · package version 581cb4be6949 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100release-notes
    Write user-facing release notes + changelogs. Keep-a-Changelog format, sections Added/Changed/Fixed/Deprecated/Removed/Security. Per-audience tone (user/dev/ops). Anti-marketing-fluff bans. Wraps `writer`. Use when the user says 'release notes for vX.Y.Z', 'changelog entry',…
  • 90change-write
    Write a changelog entry or release notes for an API version — breaking changes, new features, fixes. Use when asked to "write release notes", "add a changelog entry", or "document breaking changes".
  • 100changelog-generator
    Generate or update a repository CHANGELOG.md in Keep a Changelog format from git history - grouping commits since the last tag into Added/Changed/Deprecated/Removed/Fixed/Security, rewriting them as user-facing entries, and recommending the semantic version bump. Use when…
  • 100write-a-changelog-entry
    Writes a changelog entry for a release or a change, in plain words for the people who use the software, grouped as Added, Changed, Fixed, Removed and Security. Use when the owner asks for release notes, a changelog line or what changed in a version.
  • 100changelog
    Write release notes or a CHANGELOG.md entry from git history. Use when the user says "write the changelog", "release notes for v2.3", "what changed since the last release/tag", or is preparing a release or version bump.
  • 90changelog-writer
    Read the git log and write a user-facing changelog entry in Keep a Changelog format. Use when the user wants to document what changed in a release, write release notes, or update their CHANGELOG.md.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.