skills.rest
zhifengzhang-sz
zhifengzhang-szCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Scan diffs and update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after shipping.

Updated Feb 27, 2026
Search Tags:#automation#changelog#documentation#release#diff#docs#version
One-click install
npx skills add https://github.com/zhifengzhang-sz/divine-book --skill document-release-zhifengzhang-sz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/zhifengzhang-sz/divine-book/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/zhifengzhang-sz/divine-book --skill document-release-zhifengzhang-sz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are tedious and error-prone. This skill automates the process by reading diffs across the repo and applying changes to critical docs to reflect what shipped, ensuring consistency.

Core Features & Use Cases

  • Reads project docs and the diff to update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.
  • Polishes the CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION.
  • Proactively suggests documentation updates after PRs are merged or code is shipped.

Quick Start

Run the document-release skill after shipping to synchronize docs across the repo.

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 PR merge?▼

Automate documentation updates after a PR merge by scanning code diffs and applying changes to README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md. It reads the diff to ensure docs reflect what shipped, maintaining consistency across the repo.

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

Keeping a CHANGELOG and README in sync with code changes is best handled by scanning git diffs after shipping. This approach automatically polishes the CHANGELOG voice, cleans up TODOS, and updates critical docs to reflect the latest version of the codebase.

How does diff scanning work for updating project docs?▼

Diff scanning for updating project docs works by reading the differences between code versions using Bash scripting and standard CLI tools. It then proactively suggests and applies documentation updates to critical files based on what actually shipped.

Can I automatically bump the VERSION and clean up TODOS when shipping code?▼

Yes, you can automatically bump the VERSION and clean up TODOS when shipping code. The skill reads project diffs after shipping and optionally bumps the version file while polishing the CHANGELOG and removing completed TODOS.

Do I need any special dependencies to auto-update docs from git diffs?▼

No special dependencies are required to auto-update docs from git diffs. The skill relies entirely on standard Bash scripting and CLI tools to read diffs, update files like ARCHITECTURE and CONTRIBUTING, and commit changes.

Related Skills

Explore More Content & Communication Skills→
tarrragontarrragon
1

version-release

Automate release pre-flight checks, document updates, and Git operations.

Community
Intermediate
jonaseck2jonaseck2
2

oss-release

Enforce CHANGELOG.md release-note structure with a 10-block rolling window.

Community
Intermediate
VoDaiLoczVoDaiLocz
24

lint-and-validate

Automate linting and static analysis of code in CI pipelines.

Community
Intermediate
benjaminshoemakerbenjaminshoemaker
39

update-docs

Analyze commit ranges or working tree changes to update documentation files.

Community
Advanced