skills.rest
zzxtbeta
zzxtbetaCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project documentation from branch diffs after shipping.

Updated Mar 29, 2026
Search Tags:#planning#changelog#documentation#release#review#diff#docs
One-click install
npx skills add https://github.com/zzxtbeta/design-handbook --skill document-release-zzxtbeta
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/zzxtbeta/design-handbook/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/zzxtbeta/design-handbook --skill document-release-zzxtbeta

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Updates project documentation after shipping to reflect the latest changes across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md, ensuring docs stay in sync with shipped code.

Core Features & Use Cases

  • Synchronizes documentation with the diff from the current branch, updating key docs to reflect new functionality, changes in architecture, and updated contribution guidelines.
  • Polishes CHANGELOG language and consolidates TODOS to align with the shipped state.
  • Optionally triggers a version bump workflow when changes warrant a release.

Quick Start

Run the document-release workflow to scan shipped changes and update docs accordingly.

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 to match shipped code changes?▼

To update project documentation after shipping, analyze the diff from your current branch and modify README, ARCHITECTURE, CONTRIBUTING, and CLAUDE files to reflect the new functionality and architecture changes.

Can I automatically polish changelog language and consolidate TODOS after a release?▼

Yes, you can polish changelog language and consolidate TODOS by analyzing shipped branch diffs, respecting existing CHANGELOG entries, and adjusting documentation text to align with the released state.

Does this documentation sync workflow respect my existing CHANGELOG entries?▼

Yes, the documentation sync process respects existing CHANGELOG entries while analyzing branch diffs to update key docs, ensuring new changes integrate without overwriting prior release history.

When do I need to trigger a version bump workflow for documentation updates?▼

You need to trigger a version bump workflow when shipped changes warrant a release, following the version-bump decision workflow to adjust project documentation and reflect the new version state.

What is the best way to synchronize README and ARCHITECTURE docs after merging a feature branch?▼

The best way to synchronize README and ARCHITECTURE docs is to scan the diff data from the current branch and update targeted documentation files to match the shipped features and architectural modifications.

Are there limitations when updating CONTRIBUTING guidelines based on code diffs?▼

The main limitation is that documentation updates rely entirely on repository diff data from the current branch; without clear textual changes in the diff, CONTRIBUTING guidelines cannot be inferred or automatically generated.

Related Skills

Explore More Content & Communication Skills→
nesihaver-ILnesihaver-IL

update-docs

Update README, API, architecture docs, and changelogs after code changes.

Community
Intermediate
pythoninthegrassespythoninthegrasses
1

changelog-automation

Generate changelogs and release notes from commits, PRs, and tags.

Official
Advanced
JeremyDev87JeremyDev87
31

finishing-a-development-branch

Decide merge, pull request, or cleanup for completed development branches.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced