Post-Ship Documentation Sync

•
3.2k
•

Automates the synchronization of project documentation with code changes during the delivery phase.

This skill streamlines the final stage of the development lifecycle by ensuring project documentation accurately reflects recent code changes. By analyzing git diffs, it automatically updates factual data like file paths, version numbers, and numeric counts across markdown files while flagging narrative or philosophical sections for manual review. It also polishes CHANGELOG entries to be more user-centric and performs consistency checks to ensure that all documentation is linked, up-to-date, and professional before shipping.

主要功能

01Risky change detection for narrative, philosophy, and security sections requiring user approval.
02Intelligent CHANGELOG polishing that converts technical diffs into benefit-driven release notes.
033,216 GitHub stars
04Orphaned document discovery to ensure every markdown file is reachable from the README or CLAUDE.md.
05Automated factual correction of paths, versions, and numeric counts based on git diffs.
06Cross-document consistency validation to ensure versions and feature lists match across all files.

使用场景

01Updating READMEs and technical docs immediately after a major refactor or file restructuring.
02Maintaining global version consistency across package manifests and multiple documentation files.
03Generating professional, user-facing release notes from git commit history during a PR review.