Does it overwrite my entire CHANGELOG?

No, it uses precise editing tools to polish wording and preserve existing history without clobbering content or regenerating entries from scratch.

Can it handle custom documentation files?

Yes, it scans for all Markdown files in the project root and subdirectories to audit them based on the context of the recent code diffs.

Does it automatically bump the project version?

No, it identifies whether a version bump is appropriate for the changes and prompts the user for a decision using the AskUserQuestion tool.

When should I run the avad-document-release skill?

It is best used after code has been committed and a PR exists (or is about to exist), but before the PR is merged, to ensure documentation accurately reflects the ship.

Avad Document Release

Name: Avad Document Release
Author: agwacom

byagwacom

0•

学習とドキュメンテーション

Automates the synchronization of project documentation with recent code changes to ensure accuracy and consistency.

Avad Document Release is a post-ship automation skill for Claude Code designed to meticulously audit and update project documentation files such as README, ARCHITECTURE, and CHANGELOG. It cross-references git diffs against existing documentation to identify stale information, polishes the CHANGELOG for a user-centric voice, manages version increments, and cleans up project TODOs. By running after code is committed but before a PR is merged, it ensures that your project's documentation never lags behind its actual implementation.

主な機能

01Interactive VERSION bumping and TODO.md lifecycle management

02Comprehensive audits of README, ARCHITECTURE, and CONTRIBUTING files

03Cross-document consistency checks and broken link discovery

04Intelligent CHANGELOG voice polishing for user-forward release notes

050 GitHub stars

06Automated git diff analysis for documentation impact mapping

ユースケース

01Polishing technical CHANGELOG entries into marketing-ready release notes

02Auditing project instructions (CLAUDE.md) for stale file paths or build commands

03Syncing project documentation immediately after shipping new features or refactors

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add agwacom/avadbot avad-document-release

For use in Claude.ai and ChatGPT

主な機能

01Interactive VERSION bumping and TODO.md lifecycle management

02Comprehensive audits of README, ARCHITECTURE, and CONTRIBUTING files

03Cross-document consistency checks and broken link discovery

04Intelligent CHANGELOG voice polishing for user-forward release notes

050 GitHub stars

06Automated git diff analysis for documentation impact mapping

ユースケース

01Polishing technical CHANGELOG entries into marketing-ready release notes

02Auditing project instructions (CLAUDE.md) for stale file paths or build commands

03Syncing project documentation immediately after shipping new features or refactors

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add agwacom/avadbot avad-document-release

For use in Claude.ai and ChatGPT