documentation-lens

What problem does it solve?

Improve the usefulness of project documentation by evaluating completeness, accuracy, audience fit, and discoverability against the project's existing documentation norms so readers can succeed without asking the author for help.

Core Features & Use Cases

• API and Interface Coverage: Check that public APIs, function signatures, and data models include purpose, parameters, return values, error conditions, and working examples where appropriate.
• Developer-Facing Guidance: Assess README, getting-started guides, architecture notes, changelogs, and migration guidance for accuracy and sufficiency during onboarding or pre-implementation reviews.
• Inline and Consistency Checks: Identify outdated or misleading comments, missing rationale for complex logic, inconsistent claims between code and docs, and provide confidence ratings for each finding.
• Use Case: Use during plan review to surface documentation gaps that would block a developer from implementing or maintaining the planned changes.

Quick Start

Review the repository documentation for missing or incorrect sections, produce a prioritized list of issues with confidence ratings, and suggest actionable improvements.