What problem does it solve?
This Skill helps developers identify missing, misleading, or redundant comments and improve documentation so interfaces communicate intent, constraints, and design decisions clearly.
Core Features & Use Cases
- Comment Quality Review: Classifies interface, implementation, cross-module, and data structure comments and evaluates whether each adds meaningful information.
- Documentation Design: Detects comments that repeat code, expose leaky abstractions, or are difficult to write because the underlying design is too complex.
- Comments-First Workflow: Guides teams to document interfaces and variables before implementation to uncover design problems early and prevent comment rot.
- Use Case: Apply this Skill during a code review to find undocumented public methods, stale explanations, and comments that should be replaced by clearer abstractions.
Quick Start
Ask the comments-docs skill to review the comments and documentation quality in the specified file or module.