skills.rest
devs6186
devs6186COMMUNITY
Explore all skills by this author →
GitHub

document-release

Synchronize project documentation with shipped changes after PR merges or releases.

1|Updated Mar 19, 2026
Search Tags:#automation#changelog#versioning#documentation#release#docs
One-click install
npx skills add https://github.com/devs6186/claude-private-skills-agents-commands --skill document-release-devs6186
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/devs6186/claude-private-skills-agents-commands/tree/main/skills/gstack/document-release
Command: npx skills add https://github.com/devs6186/claude-private-skills-agents-commands --skill document-release-devs6186

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship, teams often have drift between shipped changes and their documentation. This Skill automates aligning docs to reflect what was released, reducing manual edits and version mismatches.

Core Features & Use Cases

  • Syncs and updates READMEs, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect the shipped changes.
  • Polishes the CHANGELOG narrative, tidies TODOS, and optionally bumps the VERSION.
  • Use case: after releasing a feature, run this skill to ensure all docs describe the new behavior consistently.

Quick Start

Run document-release after a PR merge or ship to align docs with the latest release.

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

Automating documentation updates involves reading merged PR diffs and applying corresponding edits to project docs like READMEs and CONTRIBUTING.md, ensuring consistency across the codebase after a release.

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

Keeping a CHANGELOG and README synced requires an automated post-ship process that reads code diffs, polishes the CHANGELOG narrative, and updates documentation files to accurately reflect the newly released behavior.

How do I update ARCHITECTURE.md and CONTRIBUTING.md after a PR merge?▼

Updating ARCHITECTURE.md and CONTRIBUTING.md after a PR merge is done by executing a documentation synchronization task that reads the shipped diffs and edits the relevant architectural and contributing guidelines accordingly.

Can I automatically bump a VERSION file when syncing post-ship documentation?▼

Yes, you can bump a VERSION file during post-ship documentation synchronization by enabling the optional version bumping feature, which aligns the version number with the newly shipped changes.

When should I run a documentation synchronization task for my project?▼

You should run a documentation synchronization task immediately after a PR merge or a release to prevent drift between your shipped code changes and your project's documentation artifacts.

How does automated changelog polishing handle TODOS and versioning?▼

Automated changelog polishing reads post-ship diffs to tidy up TODOS, optionally bump the VERSION, and refine the CHANGELOG narrative, enforcing consistency across READMEs and other project artifacts.

Related Skills

Explore More Content & Communication Skills→
YanCheng-goYanCheng-go
3

release

Generate a changelog, bump the version, and open a release PR.

Community
Intermediate
DVNghiemDVNghiem
20

git-release

Derive semantic version bumps and changelogs from merged PRs, updating CHANGELOG.md and outputting git tag/push commands.

Community
Intermediate
lushly-devlushly-dev
4

do-documentation-update

Update CHANGELOG, AGENTS.md, README.md, and skill files with validation.

Official
Intermediate
thanh-abaiithanh-abaii
34

gs:document-release

Automate post-ship documentation updates by comparing diffs and revising READMEs and CHANGELOGs.

Community
Advanced