document-release

Update project docs and changelog to reflect a shipped diff.

1|Updated Apr 6, 2026
One-click install
npx skills add https://github.com/zhu637882-stack/jiaoyi --skill document-release-zhu637882-stack
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/zhu637882-stack/jiaoyi/tree/main/qoder-config-backup/skills/gstack-document-release
Command: npx skills add https://github.com/zhu637882-stack/jiaoyi --skill document-release-zhu637882-stack

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation update. Reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. Use when asked to "update the docs", "sync documentation", or "post-ship docs".

Core Features & Use Cases

  • Auto-sync documentation to reflect released changes across core docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md).
  • Polish CHANGELOG language, tidy TODOS, and optionally bump the VERSION to match the release notes.
  • Triggered after PR merges or code shipping; supports proactive doc maintenance when requested.

Quick Start

Run this skill after shipping to automatically reconcile docs and changelogs 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 automatically update documentation after shipping a release?

Automating post-ship documentation updates involves cross-referencing the shipped diff against existing project docs. This skill reads the changes and automatically updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to accurately reflect the new release.

What is the best way to sync CHANGELOG and README files with a shipped code diff?

The best way to sync docs with a shipped code diff is using an automated post-ship doc synchronization process. It cross-references the diff to update README and ARCHITECTURE, while polishing the CHANGELOG language to match the release notes.

Can I automatically bump the VERSION and clean up TODOS during a post-ship doc sync?

Yes, you can bump the VERSION and clean up TODOs during a post-ship doc sync. The process optionally aligns the VERSION with the release and tidies up TODOs alongside updating core documentation like CONTRIBUTING and CLAUDE.md.

How does cross-referencing a shipped diff work for updating project docs?

Cross-referencing a shipped diff works by analyzing the code changes and mapping them to existing documentation. It then automatically rewrites the relevant sections in README, ARCHITECTURE, and CLAUDE.md to ensure the docs match what actually shipped.

Do I need to manually trigger documentation updates after a PR merge?

No, you do not need to manually trigger documentation updates after a PR merge. You can simply request to "update the docs" or "sync documentation", and the skill automatically reconciles the docs and changelogs with the latest release.