staleness-metrics

Documentation freshness is measured by calculating commits behind and days behind to gauge staleness. This detects misalignment between docs and code modules by analyzing commit-based aging and direct or indirect directory relationships.

Documentation drift occurs when docs become outdated relative to code changes. You detect it through project-wide audits that analyze doc-age, track commits behind, and identify direct and indirect links between documentation files and code modules.

To generate a stale documentation report, analyze the repository to compute doc-age, commits behind, and code-doc relationships. The structured report classifies freshness into Fresh, Aging, Stale, and Critical categories using configurable thresholds.

Yes, you can configure staleness thresholds to classify documentation freshness into Fresh, Aging, Stale, and Critical categories. This threshold-based reporting guides actions by highlighting which docs require immediate updates based on commit and age analysis.

Yes, documentation staleness analysis applies to project-wide doc audits and repository health checks. It implements relationship detection across directories, identifying both direct and indirect links between documentation and code modules.

The best way to prevent documentation drift is implementing commit-based staleness calculation and age-based analysis. By detecting code-doc relationships and applying threshold-based reporting, you can identify and update stale documentation before it misleads users.