patch-notes

Generate player-facing patch notes from changelogs, git history, and QA records.

Updated May 13, 2026
One-click install
npx skills add https://github.com/FrancisVarga/the-dream-machine --skill patch-notes-francisvarga
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: patch-notes
Source: https://github.com/FrancisVarga/the-dream-machine/tree/main/.claude/skills/patch-notes
Command: npx skills add https://github.com/FrancisVarga/the-dream-machine --skill patch-notes-francisvarga

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Patch notes often lag behind development work and remain too technical or incomplete, so players can’t clearly understand what changed and why.

Core Features & Use Cases

  • Change collection from multiple sources: Pulls release changelogs, docs entries, git history, sprint retrospectives, balance-change docs, and QA bug records when available.
  • Player-friendly translation of developer language: Reframes internal descriptions into clear, non-jargony explanations and preserves key before/after balance numbers.
  • Style-appropriate output and publishing workflow: Generates Brief, Detailed, or Full patch notes, then saves the results for public release and internal archiving.

Quick Start

Generate patch notes for version 1.2.0 in detailed style by running: /patch-notes 1.2.0 --style detailed.

Frequently Asked Questions about patch-notes

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate player-facing patch notes from git log and changelog files?

You can generate player-facing patch notes by feeding release changelogs, git history, sprint context, balance documents, and QA bug records into the patch-notes workflow. It translates technical developer language into clear, categorized communication for players.

How do I translate internal git commits into non-technical release communication for players?

To translate git commits into non-technical release communication, the patch-notes process reframes internal descriptions into clear explanations. It preserves key before and after balance numbers while removing jargon from developer changelog entries.

Can I create brief, detailed, or full changelog summaries for game releases?

Yes, you can create brief, detailed, or full changelog summaries for game releases. The patch-notes generation supports multiple style outputs and can automatically save the formatted results to documentation and release archives.

Does the patch notes generator require YAML frontmatter in changelog files?

Yes, the patch notes generator requires YAML-frontmatter-defined inputs to process changelog data. It validates that changelog data exists and will block the generation process if the required data is missing.

How does tone guidance work when writing release documentation from sprint context?

Tone guidance for release documentation works by detecting tone and templates from existing project docs. The patch-notes workflow then applies this detected style to ensure consistent, categorized, and player-appropriate messaging across all outputs.

What happens if QA bug records or balance change docs are missing during patch note generation?

If QA bug records or balance change docs are missing, generation proceeds using available sources like git history and release changelogs. However, the process strictly blocks execution if the core changelog data itself does not exist.