Documentation Sync

•
15
•

Automatically identifies code changes and synchronizes project documentation to ensure READMEs, CLI help, and guides remain accurate.

The Documentation Sync skill streamlines the documentation lifecycle by analyzing recent code changes—such as new TUI keybindings, CLI flags, or configuration options—and mapping them to the relevant sections of your project's documentation. It helps developers eliminate documentation rot by providing a structured workflow to update READMEs, integration recipes, and help text immediately after feature implementation, ensuring that user-facing information always reflects the current state of the codebase.

主な機能

01Automated change analysis via git diff and log inspection
0215 GitHub stars
03Smart mapping of code modifications to README and help sections
04Support for TUI keybindings and CLI command synchronization
05Verification workflows to ensure documentation consistency and accuracy
06Context-aware searching for relevant markdown files and recipes

ユースケース

01Maintaining configuration tables when adding new environment variables or settings
02Updating README keybinding lists after adding new TUI shortcuts
03Synchronizing CLI help text with newly implemented flags or commands