document-release

Cross-reference project documentation against code diffs to update stale content.

Updated May 9, 2026
One-click install
npx skills add https://github.com/kk20300113-png/my-claude-skills --skill document-release-kk20300113-png
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/kk20300113-png/my-claude-skills/tree/main/document-release
Command: npx skills add https://github.com/kk20300113-png/my-claude-skills --skill document-release-kk20300113-png

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drifts from reality after code ships, leaving READMEs, architecture docs, and changelogs stale and misleading. This Skill eliminates the tedious manual work of reconciling docs with shipped code.

Core Features & Use Cases

  • Cross-Reference Diff Analysis: Reads all project documentation and compares it against the actual code changes that shipped.
  • Multi-File Documentation Updates: Automatically updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what actually shipped.
  • Changelog Polish & Cleanup: Refines CHANGELOG voice for consistency and cleans up outdated TODOS across the codebase.
  • Optional Version Bump: Can automatically increment VERSION files to match the new release.
  • Use Case: After merging a feature PR that adds OAuth authentication, this Skill updates the README with new setup steps, revises the ARCHITECTURE doc to include the auth flow, and polishes the CHANGELOG entry.

Quick Start

Use the document-release skill to update all project documentation to match the latest shipped code and polish the changelog.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automatically update README and ARCHITECTURE docs after a code merge?

To automatically update documentation after a code merge, you need a tool that cross-references project docs against the current code diff. This skill reads your README, ARCHITECTURE, and CONTRIBUTING files to identify and patch stale content based on recently shipped changes.

What is the best way to keep project documentation in sync with git diff changes?

Keeping documentation in sync with git diff changes requires analyzing the shipped code against existing docs. This skill automates that synchronization by reading all project documentation files and applying updates to reflect the actual code modifications.

How does changelog polishing and cleanup work for post-ship documentation?

Changelog polishing works by refining the text voice for consistency and cleaning up outdated TODOS across the codebase. This skill performs these post-ship documentation updates alongside reconciling README and ARCHITECTURE files with the merged code.

Can I automatically bump version numbers in documentation after deployment?

Yes, you can automatically bump version numbers after deployment. This skill includes an optional feature to increment VERSION files, ensuring your project versioning matches the new release alongside the updated documentation.

Does this documentation update tool work without external dependencies?

Yes, this documentation update tool works without external dependencies. It operates independently to read project files, compare them against the code diff, and apply necessary updates to your documentation and changelogs.

When do I need to update CLAUDE.md files after shipping code?

You need to update CLAUDE.md files after shipping code when the merged changes alter project workflows or architecture. This skill cross-references CLAUDE.md against the current code diff to identify and fix any stale content.