document-release

Update project documentation from git diffs after code ships.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/bananaduck1/storylab --skill document-release-bananaduck1
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/bananaduck1/storylab/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/bananaduck1/storylab --skill document-release-bananaduck1

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common. This skill reads the diff from the current merge, then updates and polishes core docs (README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md) to reflect what shipped, and optionally bumps the VERSION. It also cleans up TODOS and improves CHANGELOG voice so the project is accurate and easy to understand.

Core Features & Use Cases

  • Doc-sync after release: automatically align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes.
  • Changelog polish & TODOS cleanup: refine CHANGELOG wording and tidy up outstanding TODOS.
  • Optional version bump: bump VERSION when appropriate and allowed.
  • Proactive suggestions: offer docs-sync after a PR merge or code ship.

Quick Start

Ask me to run document-release after a ship to auto-sync docs across the project.

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 documentation after a release or merge?

To automatically update documentation after a release, you need a tool that reads the git diff from shipped changes and syncs core project files. This skill updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the latest code state.

What is the best way to keep a project CHANGELOG accurate and polished?

The best way to keep a CHANGELOG accurate is to automate the refinement process during post-ship updates. This skill reads the current git diff, polishes the CHANGELOG wording, and cleans up outstanding TODOS to ensure project documentation is easy to understand.

Can I automatically bump the VERSION file when shipping code changes?

Yes, you can automatically bump the VERSION file when shipping code changes. This skill optionally increments the VERSION file during the documentation sync process if the workflow allows it.

How does doc-sync automation handle architectural and contributing guidelines?

Doc-sync automation handles architectural and contributing guidelines by reading the shipped git diff and updating ARCHITECTURE.md and CONTRIBUTING.md. This ensures all core documentation accurately reflects the newly merged code structure and workflows.

When do I need to run documentation updates after a git merge?

You need to run documentation updates after a git merge when shipped changes alter the codebase structure or behavior. This skill proactively suggests syncing docs after PR merges to prevent documentation drift across core project files.