skills.rest
zz8011
zz8011COMMUNITY
Explore all skills by this author →
GitHub

document-release

Sync project documentation with shipped code changes after a PR merge.

Updated Apr 7, 2026
Search Tags:#automation#documentation#diff-analysis#pr-workflow#version-bump#change-log
One-click install
npx skills add https://github.com/zz8011/harnesstest --skill document-release-zz8011
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/zz8011/harnesstest/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/zz8011/harnesstest --skill document-release-zz8011

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeping project documentation in sync with code changes after ship is error-prone and time-consuming. This Skill automates reviewing diffs, updating README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md, polishing CHANGELOG language, and cleaning TODOS, with optional VERSION bumps.

Core Features & Use Cases

  • Automatically review project documentation against the diff from shipped code and align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with what was shipped.
  • Polish CHANGELOG wording, tidy TODOS, and optionally bump the VERSION when appropriate.
  • Run after a PR is merged or code is shipped, proactively suggesting updates when prompted with phrases like 'update the docs' or 'sync documentation'.

Quick Start

Run the document-release workflow after a PR is merged to automatically align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes.

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 a PR is merged?▼

To update documentation after a PR is merged, you can automate the workflow by syncing docs with shipped code diffs. This process automatically aligns files like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with the new changes.

What is the best way to sync project documentation with shipped code changes?▼

The best way to sync project documentation with shipped code changes is to use an automated diff-analysis workflow. It reviews the shipped code diffs and proactively suggests updates to align your README, ARCHITECTURE, and CLAUDE.md files.

How does automated changelog polishing and version bumping work?▼

Automated changelog polishing and version bumping works by analyzing post-ship code diffs to refine changelog wording and tidy todos. It optionally bumps the VERSION file when appropriate based on the shipped changes.

Do I need to manually trigger documentation updates after shipping code?▼

You do not need to manually trigger documentation updates after shipping code. The workflow proactively suggests syncing documentation when prompted with phrases like 'update the docs' or 'sync documentation'.

What files are included in an automated post-ship documentation update?▼

An automated post-ship documentation update includes README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files. It also polishes the CHANGELOG wording, cleans TODOS, and optionally bumps the VERSION.

Related Skills

Explore More Content & Communication Skills→
forbotsakeforbotsake
5

document-release

Synchronize post-release documentation with code changes after a PR merge.

Official
Advanced
jonaseck2jonaseck2
2

oss-release

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

Community
Intermediate
ShmurdocShmurdoc

document-release

Synchronize project documentation with code diffs after releases.

Community
Advanced
tblakex01tblakex01
1

document-release

Update project documentation files to reflect shipped changes after PR merges.

Community
Advanced