document-release

Automates post-ship documentation updates by syncing files and polishing the changelog.

Updated Mar 30, 2026
One-click install
npx skills add https://github.com/agwacom/adeel --skill document-release-agwacom
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/agwacom/adeel/tree/main/skills/document-release
Command: npx skills add https://github.com/agwacom/adeel --skill document-release-agwacom

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates post-ship documentation maintenance to ensure project docs reflect shipped changes and stay in sync with code.

Core Features & Use Cases

  • Synchronize README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to match shipped changes.
  • Polish CHANGELOG language and tidy TODOS to reflect the current state of the project.
  • Optionally bump VERSION and generate a diff-ready PR body.

Quick Start

Trigger the /document-release command after you ship to align docs, polish the changelog, tidy TODOS, and optionally bump the version.

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?

To automate documentation updates after shipping, you can trigger a command that reads the git diff against the base branch and applies those changes to your project docs. This aligns your README, ARCHITECTURE, and CONTRIBUTING files with the shipped code.

What is the best way to keep a CHANGELOG and TODOS in sync with merged PRs?

Keeping a CHANGELOG and TODOS in sync with merged PRs is done by analyzing the git diff and polishing the CHANGELOG language to reflect the current state. The process automatically tidies TODOS and adjusts documentation to match the shipped changes.

Can I automatically bump a project version and generate a PR body from a git diff?

Yes, you can automatically bump a project version and generate a diff-ready PR body from a git diff. The process enforces version-bump policies and telemetry prompts while adjusting documentation to match the shipped changes.

How do I synchronize README and ARCHITECTURE docs after a code release?

To synchronize README and ARCHITECTURE docs after a code release, run a post-ship command that reads the git diff against the base branch. It automatically updates these documentation files to accurately reflect the newly shipped changes.

Does post-ship documentation automation work without external dependencies?

Post-ship documentation automation works without external dependencies, relying solely on your project's git diff and existing files like README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to synchronize docs and tidy TODOS.