skills.rest
xotong
xotongCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Scan release diffs and update project documentation files.

2|Updated May 8, 2026
Search Tags:#changelog#architecture#documentation#readme#post-release#contributing#claude.md
One-click install
npx skills add https://github.com/xotong/claude-marketplace --skill document-release-xotong
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/xotong/claude-marketplace/tree/main/plugins/gstack/skills/document-release
Command: npx skills add https://github.com/xotong/claude-marketplace --skill document-release-xotong

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often lags behind code changes. This skill reads the diff between shipped changes and project docs and updates key documents to reflect what was released, including README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md, while polishing the CHANGELOG and TODOS and optionally bumping the VERSION.

Core Features & Use Cases

  • Automated doc synchronization: aligns README, architecture notes, contribution guides, and CLAUDE-specific docs with shipped changes.
  • CHANGELOG polishing: refines language, aligns tone, and ensures entries reflect what shipped.
  • Optional version bump: can bump the VERSION when appropriate and safe.

Quick Start

Run the document-release skill after a release to automatically update the project's documentation.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate documentation updates after a release?▼

Automate post-ship documentation updates by scanning code diffs and applying changes to shipped docs. This skill targets README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to prevent drift between releases.

What is the best way to keep my README and CHANGELOG in sync with code changes?▼

Keeping README and CHANGELOG in sync is done by analyzing release diffs and applying controlled edits to project docs. This refines the changelog voice and ensures entries reflect exactly what shipped.

Can I automatically bump the VERSION file when shipping a release?▼

Yes, you can automatically bump the VERSION when appropriate and safe. The skill evaluates shipped changes and applies the version bump alongside documentation updates to maintain project consistency.

How does diff analysis work for post-release documentation synchronization?▼

Diff analysis for documentation synchronization works by reading the difference between shipped changes and existing docs, then using internal scripts to apply controlled edits that update README, ARCHITECTURE, and CONTRIBUTING files.

Do I need to manually edit CLAUDE.md after shipping new code?▼

No, manual edits to CLAUDE.md are unnecessary. The skill automatically updates CLAUDE-specific docs by scanning release diffs and applying targeted changes to align with what was shipped.

When should I not use automated documentation synchronization?▼

Automated documentation synchronization should be avoided when manual narrative control is required or when changes are highly sensitive, as the skill relies on diff analysis to apply controlled edits automatically.

Related Skills

Explore More Content & Communication Skills→
CloudyWingCloudyWing

generate-commit

Generate standardized git commit messages from git diff output.

Community
Advanced
scanbottscanbott

ship

Automate release workflows by merging branches, running tests, bumping versions, and creating PRs.

Community
Advanced
superfhpsuperfhp

requesting-code-review

Automate pre-commit code review by scanning git diffs for security vulnerabilities and quality issues.

Community
Advanced
evanfang0054evanfang0054

documentation-sync

Automates project documentation updates from code changes.

Community
Advanced