comments-docs

Review and improve software comments and documentation quality.

11|Updated Feb 25, 2026
One-click install
npx skills add https://github.com/codybrom/clairvoyance --skill comments-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: comments-docs
Source: https://github.com/codybrom/clairvoyance/tree/main/skills/comments-docs
Command: npx skills add https://github.com/codybrom/clairvoyance --skill comments-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about comments-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review code comments to prevent comment rot?

Identify stale or redundant explanations by evaluating whether comments align with current code behavior and abstraction quality, detecting leaky abstractions and misleading documentation that fail to communicate design decisions.

What is comments-first development and how does it improve software architecture?

Apply comment quality review during a code review to find undocumented public methods, detect stale explanations, and identify comments that should be replaced by clearer abstractions rather than patching poor design with text.

Why does interface design require clear documentation?

When comments are difficult to write because the underlying design is too complex, it signals that the interface design itself needs improvement rather than additional explanatory documentation to compensate for poor abstraction quality.

Can I audit documentation quality for modules that are difficult to describe?

The audit detects comments that repeat code, expose leaky abstractions, or fail to clarify design decisions, providing actionable feedback to improve documentation structure and align explanations with actual software architecture.