skills.rest
mgher668
mgher668COMMUNITY
Explore all skills by this author →
GitHub

document-release

Synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped diffs.

Updated Apr 13, 2026
Search Tags:#documentation#readme#release#diff#sync#docs#CHANGELOG
One-click install
npx skills add https://github.com/mgher668/surf-ai --skill document-release-mgher668
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/mgher668/surf-ai/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/mgher668/surf-ai --skill document-release-mgher668

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common: READMEs, architecture notes, and changelogs diverge from what shipped. This Skill reads project docs, cross-references the diff, and updates multiple docs to keep them in sync.

Core Features & Use Cases

  • Reads project documentation and diffs to identify drift.
  • Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.
  • Polishes CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION.
  • Use after PRs are merged or when you need to align docs with a release.

Quick Start

Run the document-release skill after a ship to automatically synchronize docs across README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG.

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

To automate documentation updates after a release, you can use a tool that reads project diffs and synchronizes shipped changes across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files.

What is the best way to keep my CHANGELOG and README in sync with merged PRs?▼

Keeping your CHANGELOG and README in sync with merged PRs requires cross-referencing shipped diffs to identify drift and automatically polishing doc voice, cleaning up TODOS, and updating multiple project files.

Why does my project documentation drift after shipping code changes?▼

Project documentation drifts after shipping code changes because READMEs, architecture notes, and changelogs are manually updated, requiring automated diff reading to reflect the actual shipped modifications.

Can I automatically bump the version and update TODOS when shipping changes?▼

Yes, you can automatically bump the version and update TODOS when shipping changes by running an automated post-ship synchronization process that reads diffs and polishes project documentation.

How do I maintain a consistent voice across multiple documentation files?▼

To maintain a consistent voice across multiple documentation files, an automated tool reads diffs and applies uniform updates to README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.

Related Skills

Explore More Content & Communication Skills→
jayteealaojayteealao

documentation-sync

Synchronize version numbers across project files and documentation references.

Community
Advanced
MFS-codeMFS-code
8

document-release

Audit markdown documentation against code diffs and update release notes.

Community
Advanced
luongnv89luongnv89
104

oss-ready

Generate standard OSS repository files and GitHub templates.

Community
Advanced
zhu637882-stackzhu637882-stack

document-release

Update project docs and changelog to reflect a shipped diff.

Community
Advanced