skills.rest
Chang-Shih-Yung
Chang-Shih-YungCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Align project docs with shipped changes and update CHANGELOG.

Updated Mar 25, 2026
Search Tags:#documentation#diff#docs#update#CHANGELOG#version-bump#post-ship
One-click install
npx skills add https://github.com/Chang-Shih-Yung/auto-learning --skill document-release-chang-shih-yung
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Chang-Shih-Yung/auto-learning/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/Chang-Shih-Yung/auto-learning --skill document-release-chang-shih-yung

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates post-ship documentation updates to ensure README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md reflect shipped changes, while polishing CHANGELOG and cleaning TODOS.

Core Features & Use Cases

  • Synchronize key docs with shipped changes
  • Polish CHANGELOG voice and update TODOS
  • Optionally bump VERSION
  • Proactively suggest updates after a merge or release (optional)

Quick Start

Run the document-release workflow after shipping code to update and align project docs.

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 shipping code changes?▼

To update project documentation after shipping code changes, run the post-ship workflow to read your diff and sync README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to accurately reflect what was shipped.

What is the best way to polish a CHANGELOG and clean up TODOS after a release?▼

The best way to polish a CHANGELOG and clean up TODOS after a release is to automate the process, which refines the CHANGELOG voice and removes completed TODOS while aligning project docs with shipped changes.

Can I automatically bump the VERSION file after a merge?▼

Yes, you can automatically bump the VERSION file after a merge, as the workflow optionally increments the version number and proactively suggests documentation updates following a release or merge.

How does syncing docs with a git diff work?▼

Syncing docs with a git diff works by reading all project documentation, referencing the shipped code diff, and updating architectural and contributing guides to mirror the exact changes introduced in the release.

Do I need any dependencies to automate post-ship documentation updates?▼

No, you do not need any dependencies to automate post-ship documentation updates, as the workflow operates independently without external components to align your README and CHANGELOG with shipped changes.

Related Skills

Explore More Content & Communication Skills→
XinheLIUXinheLIU

document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.

Community
Advanced
jonaseck2jonaseck2
2

oss-release

Enforce CHANGELOG.md release-note structure with a 10-block rolling window.

Community
Intermediate
shekerkammashekerkamma

document-release

Update project documentation to match shipped code changes.

Community
Advanced
MFS-codeMFS-code
8

document-release

Audit markdown documentation against code diffs and update release notes.

Community
Advanced