What inputs can Release Notes Generator accept?

It can ingest tickets (JIRA/Linear), PRDs, internal changelogs, and Git logs; read all supplied materials to extract changes, affected users, and benefits.

Does it handle breaking changes and deprecations?

Yes—the tool supports Breaking Changes and Deprecations with guidance on required user actions and migrations.

release-notes

Scanned

npx machina-cli add skill phuryn/pm-skills/release-notes --openclaw

Files (1)

SKILL.md

2.5 KB

Release Notes Generator

Transform technical tickets, PRDs, or internal changelogs into polished, user-facing release notes.

Context

You are writing release notes for $ARGUMENTS.

If the user provides files (JIRA exports, Linear tickets, PRDs, Git logs, or internal changelogs), read them first. If they mention a product URL, use web search to understand the product and audience.

Instructions

Gather raw material: Read all provided tickets, changelogs, or descriptions. Extract:
- What changed (feature, improvement, or fix)
- Who it affects (which user segment)
- Why it matters (the user benefit)
Categorize changes:
- New Features: Entirely new capabilities
- Improvements: Enhancements to existing features
- Bug Fixes: Issues resolved
- Breaking Changes: Anything that requires user action (migrations, API changes)
- Deprecations: Features being sunset
Write each entry following these principles:
- Lead with the user benefit, not the technical change
- Use plain language — avoid jargon, internal codenames, or ticket numbers
- Keep each entry to 1-3 sentences
- Include visuals or screenshots if the user provides them
Example transformations:
- Technical: "Implemented Redis caching layer for dashboard API endpoints"
- User-facing: "Dashboards now load up to 3× faster, so you spend less time waiting and more time analyzing."
- Technical: "Fixed race condition in concurrent checkout flow"
- User-facing: "Fixed an issue where some orders could fail during high-traffic periods."

Structure the release notes:

# [Product Name] — [Version / Date]

## New Features
- **[Feature name]**: [1-2 sentence description of what it does and why it matters]

## Improvements
- **[Area]**: [What got better and how it helps]

## Bug Fixes
- Fixed [issue description in user terms]

## Breaking Changes (if any)
- **Action required**: [What users need to do]

Adjust tone to match the product's voice — professional for B2B, friendly for consumer, developer-focused for APIs.

Save as a markdown document. If the user wants HTML or another format, convert accordingly.

Source

git clone https://github.com/phuryn/pm-skills/blob/main/pm-execution/skills/release-notes/SKILL.mdView on GitHub

Overview

Release-notes generates user-facing release notes from technical tickets, PRDs, or changelogs. It organizes content by category—New Features, Improvements, and Bug Fixes—so readers quickly understand what shipped and why it matters. The output is ready for product pages, changelogs, or blog announcements, with clear, publish-ready language.

How This Skill Works

Feed the system with raw materials such as tickets, PRDs, or internal changelogs. It extracts what changed, who it affects, and why it matters, then categorizes entries into New Features, Improvements, Bug Fixes, Breaking Changes, and Deprecations. It returns concise, 1–3 sentence, user-friendly notes and can include visuals if provided.

When to Use It

When shipping a new feature to a broad audience and you need clear, customer-ready notes.
When consolidating multiple tickets, PRDs, or changelogs into a single, cohesive changelog.
When announcing product updates on a blog, status page, or release notes page.
When preparing versioned release notes for external customers or internal stakeholders.
When you have visuals or screenshots to accompany notes and want them included.

Quick Start

Step 1: Gather all inputs (tickets, PRDs, changelogs) and any product URLs or visuals.
Step 2: Extract changes, determine impact, and assign each item to a category (New Features, Improvements, Bug Fixes, Breaking Changes, Deprecations).
Step 3: Write 1–3 sentence, user-focused notes and save as a Markdown release notes document (or export as HTML).

Best Practices

Lead with user benefits in every entry.
Use plain language, avoiding internal codes and ticket numbers.
Keep entries to 1–3 sentences and clearly labeled by category.
Call out Breaking Changes and Deprecations with any required user actions.
Include visuals or screenshots when provided, and verify accuracy against source materials.

Example Use Cases

New Features: 'Dark Mode' lets users switch to a high-contrast theme for easier viewing at night.
Improvements: Reports render faster and exports complete in half the time.
Bug Fixes: Fixed an issue where autosave could fail during editing.
Breaking Changes: API v2 requires migrating OAuth scopes; update tokens before next release.
Deprecations: Legacy widgets sunset; migrate to the new widgets in the next release.

Frequently Asked Questions

Add this skill to your agents