skills.rest
rkumar261
rkumar261COMMUNITY
Explore all skills by this author →
𝕏@r_kumar261GitHub

document-release

Synchronize project documentation with shipped changes using git diffs.

1|Updated Dec 23, 2025
Search Tags:#automation#documentation#claude#diff#CHANGELOG#post-ship#docs-polish
One-click install
npx skills add https://github.com/rkumar261/studio-cast --skill document-release-rkumar261
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/rkumar261/studio-cast/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/rkumar261/studio-cast --skill document-release-rkumar261

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship teams spend manual time aligning multiple docs after a release. This skill automatically syncs the shipped changes across project documentation, polishes sections like the CHANGELOG and TODOS, and ensures CLAUDE.md, README.md, ARCHITECTURE.md, and CONTRIBUTING.md reflect the latest state.

Core Features & Use Cases

  • Cross-file synchronization: reads the diff and updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to match shipped changes.
  • Documentation polish: refines CHANGELOG voice and tidies TODOS for a cleaner project narrative.
  • Optional version bump: can bump VERSION when changes warrant a new release, or suggest improvements post-ship.
  • Proactive workflows: when a PR is merged or code is shipped, suggests docs updates and ensures consistency across docs.

Quick Start

Run after a PR is shipped to align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with the latest changes.

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 shipping a release?▼

Automate post-ship documentation updates by reading git diffs to synchronize README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with the latest shipped changes. This ensures cross-file consistency automatically after a PR merge.

Can I automatically sync my CHANGELOG and TODOS with the latest git diff?▼

Yes, you can sync CHANGELOG and TODOS with the latest git diff. The process refines the CHANGELOG voice and tidies TODOS entries to maintain a cleaner project narrative aligned with recent code changes.

What is the best way to keep README and ARCHITECTURE docs aligned after a PR merge?▼

Keep README and ARCHITECTURE docs aligned after a PR merge by running an automated cross-file synchronization process that reads shipped git diffs and edits the documentation to reflect the latest project state.

Does this documentation automation support bumping the VERSION file?▼

Yes, the documentation automation supports bumping the VERSION file. It can automatically update the version number when the shipped changes warrant a new release, alongside polishing the CHANGELOG.

Which project files are synchronized during post-ship documentation polish?▼

Synchronized project files include README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md. Optional updates target the CHANGELOG, TODOS, and VERSION files depending on the shipped changes.

When should I not use automated cross-file documentation synchronization?▼

Avoid automated cross-file documentation synchronization when a release lacks code changes affecting the project structure, as reading empty git diffs will not yield meaningful updates to README, ARCHITECTURE, or CONTRIBUTING docs.

Related Skills

Explore More Content & Communication Skills→
stayconnectquickstayconnectquick

document-release

Update core project docs after shipped code changes.

Community
Intermediate
mi179mi179
1

document-release

Synchronizes project docs with shipped changes and generates a Diataxis coverage map.

Community
Advanced
The13thNodeThe13thNode
3

document-release

Scan git diffs and update markdown documentation for releases.

Community
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate