skills.rest
nhattran998
nhattran998COMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Cross-reference repository diffs and update project documentation after releases.

Updated Mar 30, 2026
Search Tags:#changelog#documentation#post-release#diff#claude.md#docs-sync#version-bump
One-click install
npx skills add https://github.com/nhattran998/personal-athlete-agent --skill document-release-nhattran998
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/nhattran998/personal-athlete-agent/tree/main/.agents/skills/gstack-document-release
Command: npx skills add https://github.com/nhattran998/personal-athlete-agent --skill document-release-nhattran998

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common. This skill reads all project docs, cross-references the changes from the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION.

Core Features & Use Cases

  • Reads project docs, cross-references shipped changes, and updates key docs to reflect the shipped state.
  • Proactively suggests updates after a PR is merged or code is shipped to keep documentation aligned with reality.
  • Maintains CHANGELOG consistency and helps bump VERSION when requested.

Quick Start

Run the document-release skill after a release to align all project docs with what shipped.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update project documentation after a release to match shipped changes?▼

Post-release documentation sync involves reading project docs, cross-referencing shipped changes from the repository diff, and updating key files like README and ARCHITECTURE to match the latest product state.

What is the best way to keep changelog and CLAUDE.md notes aligned after a PR merge?▼

The best way to keep changelog and CLAUDE.md notes aligned is reading the PR diff, polishing the CHANGELOG voice, and updating CLAUDE.md notes to reflect the integrated code modifications.

When do I need to sync docs and bump the VERSION file?▼

You need to sync docs and bump the VERSION file during post-release cleanup or after PR merges to ensure documentation mirrors the shipped product and accurately reflects the new version.

Can I automate post-ship documentation updates for my code repository?▼

You can automate post-ship documentation updates by reading project docs and cross-referencing shipped changes against the repository diff, automatically updating key documentation to reflect the latest state.

Does this docs-sync process handle cleanup of TODOS and architecture notes?▼

The docs-sync process handles cleanup of TODOS and polishes ARCHITECTURE notes by reading project documentation to ensure all auxiliary notes are consistent with the shipped code changes.

Related Skills

Explore More Content & Communication Skills→
tblakex01tblakex01
1

document-release

Update project documentation files to reflect shipped changes after PR merges.

Community
Advanced
marcel-heinzmarcel-heinz
4

release

Coordinate ClawCity release workflows with version bumps, changelog updates, git tagging, and GitHub releases.

Community
Advanced
richardadonnellrichardadonnell
45

semantic-versioning

Automate semantic versioning and changelog generation from conventional commits.

Community
Advanced
zhu637882-stackzhu637882-stack

document-release

Update project docs and changelog to reflect a shipped diff.

Community
Advanced