skills.rest
gfires
gfiresCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Scan merged diffs and update documentation files after shipping.

Updated Aug 23, 2026
Search Tags:#documentation#release-notes#docs-sync#version-bump#change-log#post-ship
One-click install
npx skills add https://github.com/gfires/motion-analysis --skill document-release-gfires
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/gfires/motion-analysis/tree/main/document-release
Command: npx skills add https://github.com/gfires/motion-analysis --skill document-release-gfires

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts as code changes, and this Skill keeps documentation in sync automatically by reading shipped diffs and updating the standing docs to reflect what shipped.

Core Features & Use Cases

  • Cross-doc synchronization: updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to match shipped changes.
  • CHANGELOG polish and TODOS cleanup: polishes voice and removes cruft, ensuring consistency with release notes.
  • Version bumping: optionally bumps the VERSION to reflect a new release.

Quick Start

Run the document-release workflow after a PR is merged or code is shipped to automatically scan and align docs.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep documentation in sync after merging a PR?▼

Keeping documentation in sync after a merge requires scanning shipped diffs and updating standing docs. This Skill reads PR changes and automatically aligns README, ARCHITECTURE, CONTRIBUTING, and CLAUDE files to reflect what shipped.

What is the best way to automate release notes generation from code diffs?▼

Automating release notes generation from code diffs involves polishing the CHANGELOG voice and removing cruft. This Skill scans merged PR diffs to clean up TODOS and ensure consistency between shipped changes and release notes.

Does this documentation sync tool update the VERSION file automatically?▼

Yes, this documentation sync tool optionally bumps the VERSION file to reflect a new release. It records the changes for traceability while aligning README and ARCHITECTURE docs with the latest shipped code.

When should I run post-ship documentation updates?▼

You should run post-ship documentation updates immediately after a PR is merged or code is shipped. Running the workflow at this point scans fresh diffs and prevents documentation drift before it accumulates.

Can I use this to fix documentation drift across multiple markdown files?▼

Yes, you can fix documentation drift across multiple markdown files. It cross-synchronizes README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md by reading shipped diffs and aligning all standing docs with the latest changes.

Related Skills

Explore More Software Engineering Skills→
Jesse-L-MJesse-L-M

document-release

Scan diffs and update README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG after releases.

Community
Advanced
sanskarbasnetsanskarbasnet
1

document-release

Align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes.

Community
Intermediate
Extremez-SuryaExtremez-Surya

release

Automate the release process for vercel-plugin with gates, version bump, artifacts, commit, and push.

Community
Advanced
MFS-codeMFS-code
8

document-release

Audit markdown documentation against code diffs and update release notes.

Community
Advanced