Documentation Freshness Audit

What problem does it solve?

This Skill addresses the common issue of outdated or missing documentation, which can lead to confusion, errors, and a poor developer or user experience.

Core Features & Use Cases

• Stale README Detection: Identifies documentation that hasn't been updated since the last code change.
• Orphaned Reference Checking: Finds documentation pointing to code or features that no longer exist.
• Missing Documentation Identification: Flags new code or features that lack corresponding documentation.
• Link Validation: Checks for broken internal and external links within documentation.
• Use Case: Before a major release, run this audit to ensure all new features are documented and existing documentation accurately reflects the codebase, preventing support issues and improving onboarding.

Quick Start

Run the documentation freshness audit for the entire project.