skills.rest
agwacom
agwacomOFFICIAL
Explore all skills by this author →
GitHub

avad-document-release

Automate post-ship documentation alignment by updating README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Updated Mar 18, 2026
Search Tags:#changelog#documentation#readme#diff#docs#cross-reference#post-ship
One-click install
npx skills add https://github.com/agwacom/avadbot --skill avad-document-release
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: avad-document-release
Source: https://github.com/agwacom/avadbot/tree/main/skills/avad-document-release
Command: npx skills add https://github.com/agwacom/avadbot --skill avad-document-release

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps project documentation in sync after shipping changes by automatically reviewing diffs and updating key docs to reflect the latest state.

Core Features & Use Cases

  • Diff-driven doc synchronization: reads the diff from shipped changes and updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md accordingly.
  • Changelog polish & TODOS cleanup: polishes CHANGELOG voice and cleans up outstanding TODOS to reflect the real state of the project.
  • Post-ship governance automation: optionally bumps VERSION and ensures consistent documentation across the repository after merges.

Quick Start

Run after a PR is merged to refresh all docs and push the updated files to the branch.

Frequently Asked Questions about avad-document-release

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

FAQPage Schema
How do I keep documentation in sync after a merge?▼

To keep documentation in sync after a merge, automate post-ship doc alignment by cross-referencing shipped diffs and updating README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to reflect the latest project state.

What is the best way to polish a changelog after shipping changes?▼

The best way to polish a changelog after shipping is to automate voice refinement and clean up outstanding TODOS, ensuring the changelog accurately reflects the real state of the merged project updates.

Can I automatically update README and ARCHITECTURE files based on git diffs?▼

Yes, you can automatically update README and ARCHITECTURE files by reading the diff from shipped changes and synchronizing the documentation content to match the latest codebase updates.

Does post-ship documentation governance support automatic version bumping?▼

Yes, post-ship documentation governance supports optionally bumping the VERSION file and ensures consistent documentation across the repository after merges are completed.

How do preflight and safety checks handle risky documentation edits?▼

Preflight and safety checks handle risky edits by verifying factual updates during synchronization and prompting for confirmation before applying potentially unsafe documentation modifications.

Related Skills

Explore More Content & Communication Skills→
clover-stormclover-storm

sync-docs

Detect code changes from git diffs and update corresponding documentation sections.

Community
Intermediate
cbleckercblecker
5

creating-pull-request

Automate GitHub pull request creation with branch pushing and PR metadata.

Community
Basic
Ryno-Crypto-Mining-ServicesRyno-Crypto-Mining-Services

documentation-update

Insert new entries into Markdown tables while preserving formatting and alphabetical order.

Official
Basic
evanfang0054evanfang0054

documentation-sync

Automates project documentation updates from code changes.

Community
Advanced