What problem does it solve?
This Skill helps identify comments, docstrings, and embedded documentation that are stale, misleading, redundant, or bloated while preserving prose that communicates important system constraints.
Core Features & Use Cases
- Architecture-Aware Review: Reconstruct components, boundaries, lifecycles, and documentation audiences before judging individual comments.
- Comprehensive Coverage: Examine APIs, state transitions, domain rules, operations, tooling directives, accuracy, clarity, and missing consequential documentation.
- Evidence-Based Findings: Classify issues as confirmed defects, worthwhile improvements, or unresolved questions and recommend the smallest safe correction.
- Use Case: Review a codebase before release to remove outdated docstrings, retain security and concurrency rationale, and identify missing documentation for public interfaces.
Quick Start
Use the audit-comments skill to review comments and docstrings throughout the specified path, preserving only accurate and consequential documentation.