skills.rest
Jia-Hong-Peng
Jia-Hong-PengCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Synchronize project documentation with shipped code changes across multiple document types.

Updated Feb 24, 2026
Search Tags:#automation#changelog#documentation#readme#sync#version-bump#post-ship
One-click install
npx skills add https://github.com/Jia-Hong-Peng/jolike.com --skill document-release-jia-hong-peng
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Jia-Hong-Peng/jolike.com/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/Jia-Hong-Peng/jolike.com --skill document-release-jia-hong-peng

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After shipping code, documentation often drifts out of sync with reality. This Skill automates the tedious process of updating READMEs, architecture docs, contributing guides, and changelogs to match what actually shipped, ensuring your project documentation stays accurate without manual effort.

Core Features & Use Cases

  • Cross-reference Diffs: Automatically compares shipped code changes against existing documentation to identify what needs updating.
  • Multi-doc Updates: Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files in one pass.
  • Changelog Polish: Refines CHANGELOG voice and tone for consistency.
  • Cleanup Tasks: Removes completed TODOS and optionally bumps version numbers.
  • Use Case: After merging a PR that adds a new API endpoint, this Skill updates the API documentation, adds the change to the changelog, and removes any related TODOs.

Quick Start

Use the document-release skill to update all project documentation after your latest code changes have been shipped.

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

To automatically update documentation after shipping code, you can use a post-ship workflow tool that reads project diffs and applies targeted edits to keep your docs accurate without manual effort.

What is the best way to keep a project changelog and README in sync with merged code?▼

Keeping a project changelog and README in sync requires cross-referencing shipped code diffs against existing files to identify necessary updates and apply them across multiple document types in one pass.

How do I clean up completed TODOs in my codebase after a release?▼

Cleaning up completed TODOs after a release involves scanning the codebase for resolved tasks and automatically removing the corresponding markers to maintain a clean project state.

Can I update architecture docs and contributing guides at the same time as my changelog?▼

Yes, you can update architecture docs and contributing guides simultaneously by applying multi-doc updates that process README, ARCHITECTURE, CONTRIBUTING, and changelog files in a single pass.

Does automating documentation sync work for bumping version numbers too?▼

Automating documentation sync can handle version bumping by optionally incrementing version numbers in project files while applying other targeted edits during the post-ship workflow.

Related Skills

Explore More Software Engineering Skills→
cegit27cegit27
3

document-release

Synchronize markdown documentation with shipped code changes via git diffs.

Official
Intermediate
nesihaver-ILnesihaver-IL

update-docs

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

Community
Intermediate
jimmymalhanjimmymalhan
1

auto-merge

Merge pull requests automatically after CI checks pass.

Community
Intermediate
jerrywu001jerrywu001
6

document-release

Sync README and related docs with shipped code diffs.

Community
Advanced