Post-Ship Documentation Sync
Automates project documentation synchronization by cross-referencing code diffs and updating markdown files.
The Post-Ship Documentation Sync skill ensures your project's markdown documentation never falls out of sync with your code. During the delivery phase, it automatically scans git diffs to update factual references such as version numbers, file paths, and counts across your README and docs folder. It intelligently flags narrative or philosophical sections for human review, polishes CHANGELOG entries into user-benefit statements, and identifies orphaned documentation to maintain a high-quality, professional project presence without the manual overhead.
Key Features
01Detects orphaned markdown files to ensure every doc is discoverable
023,585 GitHub stars
03Auto-updates factual content like version numbers, counts, and file paths
04Polishes CHANGELOG entries using the 'sell test' for user-focused benefits
05Flags narrative and philosophy sections for manual user confirmation before editing
06Performs cross-document consistency checks to align versions across all files
Use Cases
01Updating README and version references immediately after a major release
02Transforming technical commit messages into professional CHANGELOG entries
03Auditing large documentation folders for broken links and orphaned files