util-docs-audit

Documentation drift is detected by comparing documentation files against code changes to identify discrepancies. This analysis scans for outdated content, deprecated API usage, and broken references caused by code modifications.

Auditing documentation for broken references and stale content involves scanning all documentation files to identify outdated information, dead links, and placeholder TODO markers. This ensures repository documentation remains accurate and up-to-date.

Yes, you can check for deprecated API usage in markdown documentation automatically. The audit scans documentation files to flag outdated API references and content quality issues like placeholders or TODO markers.

Yes, Python is required to run a documentation freshness and accuracy scan. The Skill relies on Python scripts to perform the repository analysis, detect code-to-doc drift, and generate the final audit reports.

A repository documentation audit identifies content quality issues such as TODO markers, placeholders, stale information, and deprecated API usage. It also detects broken references and dead documentation within the codebase.

You should scan your repository for outdated and dead documentation regularly to maintain quality. Running the audit after significant codebase updates ensures documentation aligns with the current state of the code and prevents drift.