skills.rest
Bradliebs
BradliebsCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project documentation files to reflect shipped code changes.

Updated Mar 14, 2026
Search Tags:#automation#changelog#documentation#claude#docs-sync#post-ship
One-click install
npx skills add https://github.com/Bradliebs/VolumeTurtle --skill document-release-bradliebs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Bradliebs/VolumeTurtle/tree/main/.gstack/document-release
Command: npx skills add https://github.com/Bradliebs/VolumeTurtle --skill document-release-bradliebs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the tedious task of aligning project documentation after shipping code by reading diffs and updating core docs to reflect shipped changes.

Core Features & Use Cases

  • Diff-driven updates: updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match shipped changes.
  • Changelog polishing: harmonizes tone and formatting, ensuring the changelog communicates impact clearly.
  • Version bumps: optionally increment VERSION when requested.

Quick Start

Run the document-release skill after a ship to update docs across the repo.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate documentation updates after shipping code changes?▼

You can automate post-ship documentation alignment by scanning project diffs and automatically updating core files like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the shipped changes.

How do I update my changelog and TODOs automatically from a git diff?▼

Updating your changelog and cleaning up TODOs automatically involves reading repository diffs to polish the changelog voice and clearing outdated tasks, ensuring documentation accurately communicates the latest impact.

Can I automatically bump my project VERSION when updating repository docs?▼

Yes, you can optionally increment the VERSION file when running automated post-ship documentation updates, ensuring your version tracking stays synchronized with the latest shipped code.

What is the best way to keep CLAUDE.md synchronized with shipped architecture changes?▼

The best way to keep CLAUDE.md synchronized is using diff-driven updates that cross-reference shipped changes and write polished content directly back to the repository's core documentation files.

Do I need specific dependencies to automate post-ship docs-sync across my repository?▼

No external dependencies are required; the automation uses Bash and the repository's existing text tooling to read diffs, generate polished content, and write documentation updates back to the project.

Related Skills

Explore More Content & Communication Skills→
superfhpsuperfhp

requesting-code-review

Automate pre-commit code review by scanning git diffs for security vulnerabilities and quality issues.

Community
Advanced
t0labt0lab
2

release

Analyze Conventional Commits to draft changelogs and create release commits and tags.

Official
Advanced
gajjalaashok75-UIgajjalaashok75-UI
2

doc-updater

Update repository documentation to match current code and commands.

Community
Intermediate
kk20300113-pngkk20300113-png

document-release

Cross-reference project documentation against code diffs to update stale content.

Community
Intermediate