Documentation Freshness Audit

A documentation freshness audit compares document modification dates against corresponding code changes to identify stale, orphaned, or missing documentation. This ensures your documentation accurately reflects the current codebase.

Auditing documentation freshness identifies stale README files by checking if they have been updated since the last code change. Running this audit before a major release verifies all new features are documented and existing documentation is accurate.

An orphaned reference audit checks markdown files and API specifications to locate documentation pointing to code or features that no longer exist. This prevents user confusion and support issues.

Validating broken links in markdown and API specifications is done by running a documentation audit. The audit checks internal and external links across documentation files to ensure overall accuracy.

Identifying missing documentation for new code involves an audit that flags new code or features lacking corresponding documentation. This ensures complete documentation coverage for onboarding and release preparation.