documentation-sync

Documentation drift is detected by comparing code changes against related docs to identify inaccuracies, gaps, and outdated details. The skill scans READMEs, API references, architecture notes, and changelogs to produce actionable change proposals for synchronization.

The best way to find outdated READMEs and API references is by running a staleness detection scan. This process measures documentation coverage, highlights undocumented codebase gaps, and generates a validation report flagging items needing updates.

To fix documentation staleness after modifying your codebase, generate a documentation update plan. This produces actionable recommendations and change proposals that you can review and apply directly to inline docs, READMEs, and architecture notes.

Yes, you can analyze documentation coverage for architecture notes and changelogs. The coverage analysis feature measures how much of the codebase is documented and highlights gaps across these specific documentation types.

Yes, documentation synchronization works without external dependencies. The skill operates independently to compare code changes against related documentation, requiring no additional components or external libraries to generate update proposals.

You should run a documentation sync scan continuously or after significant code changes to prevent inconsistencies. This ensures that inline docs, API references, and changelogs are validated against the latest codebase updates for quick remediation.