speckit-review-comments

Analyze code comments for factual accuracy, completeness, and long-term value.

9|4|Updated May 13, 2025
One-click install
npx skills add https://github.com/opsmill/infrahub-mcp --skill speckit-review-comments
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: speckit-review-comments
Source: https://github.com/opsmill/infrahub-mcp/tree/main/.agents/skills/speckit-review-comments
Command: npx skills add https://github.com/opsmill/infrahub-mcp --skill speckit-review-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Code comment accuracy verification, documentation completeness assessment, and comment rot detection to prevent technical debt from creeping into codebases.

Core Features & Use Cases

  • Factual accuracy validation: cross-checks claims in comments against actual code behavior and signatures.
  • Completeness and longevity: flags missing context, edge cases, and outdated references to ensure long-term maintainability.
  • Use Case: a team reviews a large codebase to surface ambiguous or misleading comments and generate a prioritized remediation plan.

Quick Start

Provide a structured comment-review for a codebase using the speckkit framework and return prioritized findings without modifying source code.

Frequently Asked Questions about speckit-review-comments

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

FAQPage Schema
How do I detect comment rot and outdated documentation in a codebase?▼

Code comment accuracy validation cross-checks claims in comments against actual code behavior and signatures. It identifies factual inaccuracies, missing edge cases, and outdated references to ensure long-term maintainability and prevent technical debt.

What is the best way to verify factual accuracy of code comments?▼

The best way to verify factual accuracy is applying the speckit-review-comments framework, which cross-checks claims in comments against actual code behavior and signatures. This flags misleading or ambiguous statements without modifying the source code.

How do I assess documentation completeness for long-term maintainability?▼

Documentation completeness assessment flags missing context, edge cases, and outdated references within comments. This ensures long-term maintainability by verifying that comments provide necessary long-term value and prevent misinterpretations across the codebase.

Can I generate a prioritized remediation plan for misleading code comments?▼

Yes, you can generate a prioritized remediation plan by running a structured comment-review on a codebase. The analysis details critical issues, improvements, removals, and positive findings, returning prioritized findings without modifying source code.

Does static analysis for comment quality require modifying the source code?▼

No, static analysis for comment quality does not require modifying source code. The speckit-review-comments framework performs a structured review and returns prioritized findings detailing critical issues and improvements while leaving the original codebase untouched.