syncing-docs-with-code

You can audit documentation drift by analyzing Git commit history to identify stale references in README files, architecture notes, and user guides. The skill verifies actual source code behavior before editing and committing documentation updates to ensure written claims match the current codebase.

The best way to keep README files synchronized is to perform source-grounded verification against recent Git history. This method compares feature and fix commits with the current source code to identify outdated claims, update stale references, and prepare accurate documentation commits.

To audit repository documentation against Git history, you review root documents, package READMEs, user guides, and agent instructions using authoritative commit timestamps. The audit verifies claims against current source code and accounts for renamed or restructured documents before updating.

Yes, Git history provides authoritative timestamps to verify outdated claims in architecture notes and package guides. The process inspects actual source files after behavior changes to ensure written documentation accurately reflects the current codebase before preparing documentation commits.

Yes, documentation synchronization requires inspecting the current source code to verify claims before editing. By comparing feature and fix commits with the actual source files, the process ensures written documentation updates are grounded in verified behavior rather than assumed changes.

Stale references can be checked in root documentation, package READMEs, user guides, architecture notes, skills, and agent instructions. The audit comprehensively reviews these files while accounting for renamed or restructured documents to correct any documentation drift after commits.