proj-sync-doc

To synchronize technical documentation and unit tests with code changes, this Skill parses git commits to extract changes, classifies their impact, and updates docs in docs/req and docs/design alongside adjusting tests. It requires user confirmation before applying updates to ensure accuracy.

Yes, you can automatically update requirements docs after an urgent hotfix. The Skill applies during urgent hotfixes and regular development cycles, extracting change points from git commits to evaluate impact and align docs/req and docs/design with the latest code state.

Git commit parsing for keeping documentation in sync works by extracting changes from recent commits, classifying their impact on requirements and design, then proposing updates to docs/req and docs/design. The mechanism ensures documentation reflects the latest code changes after user confirmation.

No specific dependencies or components are required to run proj-sync-doc. The Skill operates independently to parse git commits, evaluate impact on requirements and technical documentation, and adjust unit tests within your existing repository structure.

The best way to maintain documentation consistency during ongoing refactoring is using an automated synchronization approach. This Skill parses git commits, evaluates the impact of refactoring changes, and updates docs/req, docs/design, and unit tests with user confirmation before applying updates.

You should not use automated documentation synchronization when changes are incomplete or uncommitted, because the Skill relies on parsing git commits to extract changes. It requires user confirmation before applying updates, meaning uncommitted work will not be evaluated for documentation or test alignment.