skills.rest
pradeepmouli
pradeepmouliCOMMUNITY
Explore all skills by this author →
GitHub

speckit-review-comments

Audit code comments for factual accuracy, completeness, and maintainability.

2|Updated Jan 29, 2026
Search Tags:#maintainability#code-review#technical-debt#documentation-quality#comment-analysis#code-comment
One-click install
npx skills add https://github.com/pradeepmouli/lspeasy --skill speckit-review-comments-pradeepmouli
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: speckit-review-comments
Source: https://github.com/pradeepmouli/lspeasy/tree/main/.github/skills/speckit-review-comments
Command: npx skills add https://github.com/pradeepmouli/lspeasy --skill speckit-review-comments-pradeepmouli

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Protect codebases from comment rot by ensuring every comment adds genuine value and remains accurate as code evolves.

Core Features & Use Cases

  • Comment factual correctness checks against code implementations
  • Completeness evaluation for assumptions, edge cases, and documentation alignment
  • Long-term value assessment with actionable improvement suggestions (Use Case: Identify outdated or misleading comments in a data-parsing function and propose precise rewrite suggestions)

Quick Start

Run the speckit-review-comments skill on your project to generate a structured comments-quality feedback report.

Frequently Asked Questions about speckit-review-comments

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

FAQPage Schema
How do I check code comments for factual accuracy against the implementation?▼

To check code comments for factual accuracy, analyze inline comments and docblocks to verify alignment with code implementations, flagging outdated notes and suggesting precise improvements to prevent comment rot.

What is the best way to identify outdated or misleading comments in a codebase?▼

The best way to identify outdated or misleading comments is to audit inline comments and docblocks for factual correctness, evaluating long-term maintainability and providing structured, actionable feedback for maintainers.

How do I evaluate the long-term maintainability of code documentation?▼

Evaluate code documentation maintainability by assessing comment completeness for edge cases and assumptions, documenting non-obvious decisions, and enforcing alignment with implementation to ensure lasting technical value.

Can I audit inline comments and docblocks for diverse codebases?▼

Yes, you can audit inline comments and docblocks across diverse codebases to check factual correctness, evaluate completeness, and generate a structured comments-quality feedback report with actionable rewrite suggestions.

What are common limitations when analyzing code comments for technical debt?▼

A limitation when analyzing code comments for technical debt is relying solely on automated checks without human context, which may misinterpret non-obvious decisions or documentation references that require maintainer insight.

Related Skills

Explore More Software Engineering Skills→
patricio0312revpatricio0312rev
5

jsdoc-typescript-docs

Generate API documentation from JSDoc comments in TypeScript projects.

Community
Intermediate
pdovhomiljapdovhomilja

Global Commenting

Generate concise comments explaining complex logic in code files.

Community
Basic
ryanthedevryanthedev
351

cc-documentation-quality

Automate documentation quality reviews across codebases during PR reviews.

Community
Basic
HadokennnHadokennn
5

code-documentation

Generate READMEs, API references, and developer guides from source code.

Community
Advanced