document-release

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

Updated Mar 27, 2026
One-click install
npx skills add https://github.com/Jesse-L-M/scz-target-engine --skill document-release-jesse-l-m
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Jesse-L-M/scz-target-engine/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/Jesse-L-M/scz-target-engine --skill document-release-jesse-l-m

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps shipped project documentation in sync by scanning diffs and applying updates across key docs such as README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG. This reduces drift between code and documentation and speeds up post-ship housekeeping.

Core Features & Use Cases

  • Automated cross-document updates: Detects changes from merges or releases and propagates them to the main docs.
  • CHANGELOG polish and TODOS cleanup: Improves tone and readability, and tidies outstanding tasks.
  • Optional version bumping: If requested, automatically bumps the project VERSION to reflect shipped changes.

Quick Start

Run document-release after a ship to synchronize documentation 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 keep documentation in sync after a git release?

To keep documentation in sync after a git release, you can automate the process by scanning code diffs and propagating updates across key project files like README, ARCHITECTURE, and CHANGELOG. This ensures shipped code and docs remain consistent.

What is documentation drift and how do I prevent it in my workflow?

Documentation drift occurs when shipped code changes are not reflected in project docs. Prevent drift by automating post-ship housekeeping tasks to scan repository diffs and apply corresponding updates across README, CONTRIBUTING, and CLAUDE.md files.

Can I automatically update the CHANGELOG and bump the version when merging a PR?

Yes, you can automatically update the CHANGELOG and bump the project version when merging a PR. The process detects changes from merges, polishes the CHANGELOG, cleans up TODOS, and optionally applies a version bump to reflect shipped changes.

Does automated docs sync work with CLAUDE.md and ARCHITECTURE files?

Yes, automated docs sync works with CLAUDE.md and ARCHITECTURE files. The process specifically targets these files alongside README, CONTRIBUTING, and CHANGELOG to apply updates detected from diffs, ensuring comprehensive documentation consistency across your repository.

What is the best way to automate post-ship housekeeping for project documentation?

The best way to automate post-ship housekeeping is using Bash scripts that read, write, and edit repository files based on scanned diffs. This approach quickly propagates updates across key docs and optionally bumps the project VERSION.