skills.rest
ngocsangyem
ngocsangyemCOMMUNITY
Explore all skills by this author →
𝕏@ngocsangyemGitHub

meow:document-release

Synchronize README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with shipped code changes.

14|2|Updated Mar 25, 2026
Search Tags:#workflow#documentation#diff#docs#polish#post-ship
One-click install
npx skills add https://github.com/ngocsangyem/MeowKit --skill meow-document-release
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: meow:document-release
Source: https://github.com/ngocsangyem/MeowKit/tree/main/.claude/skills/meow%3Adocument-release
Command: npx skills add https://github.com/ngocsangyem/MeowKit --skill meow-document-release

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Post-ship documentation often drifts out of sync with shipped changes, leading to confusion and outdated READMEs, ARCHITECTURE notes, and CLAUDE guidelines. This Skill ensures documentation stays accurate, consistent, and friendly to users by automatically aligning docs with what shipped and polishing tone.

Core Features & Use Cases

  • Auto-syncs README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with the current diff after code ships.
  • Polishes CHANGELOG voice and flags any deferred work for follow-up review.
  • Performs cross-document consistency checks and generates a doc health summary suitable for PRs.

Quick Start

Run the document-release skill after shipping to synchronize and polish project docs.

Frequently Asked Questions about meow:document-release

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

FAQPage Schema
How do I automatically sync README and architecture docs after shipping code?▼

You can automate post-ship documentation synchronization by running a guided workflow that analyzes the current diff and auto-updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect the shipped code changes.

What is the best way to keep project documentation consistent with merged pull requests?▼

The best way to keep documentation consistent with merged PRs is to use cross-document consistency checks that align doc content with the actual diff, generate a health summary, and polish the changelog voice for user-friendly updates.

How does diff analysis work for updating post-ship documentation?▼

Diff analysis for post-ship documentation works by examining the shipped code changes and mapping them to relevant sections in README.md, ARCHITECTURE.md, and CONTRIBUTING.md to automatically apply corresponding text updates.

Can I polish a changelog and flag deferred work during doc synchronization?▼

Yes, you can polish the changelog voice and flag deferred work for follow-up review during the documentation synchronization workflow, ensuring shipped changes are accurately documented and pending tasks are tracked.

Does the documentation workflow support optional version-bump prompts?▼

Yes, the documentation workflow supports optional version-bump prompts, allowing you to manage versioning alongside automated doc updates, cross-document checks, and changelog polishing after code ships.

When should I run post-ship documentation updates?▼

You should run post-ship documentation updates immediately after PRs are merged or shipped to code, ensuring README.md, ARCHITECTURE.md, and CLAUDE.md never drift out of sync with the actual repository state.

Related Skills

Explore More Content & Communication Skills→
LukasStricklerLukasStrickler
4

docs-check

Analyze git diffs to identify required documentation updates after code changes.

Community
Basic
cajiascajias

pr-monitor

Monitor GitHub pull requests for new commits and resume review workflows.

Community
Advanced
DrLuggelsDrLuggels
3

changelog-automation

Generate changelogs and release notes from Conventional Commits.

Community
Advanced
ligianehualigianehua

document-release

Update project documentation files based on the repository diff.

Community
Advanced