doc-code-review-report

Verify document claims against the codebase and produce an evidence-backed findings report.

139|20|Updated Jul 5, 2025

Search Tags:#codebase #evidence #code-review #api-docs #documentation-verification #design-notes

Ready to run

npx skills add https://github.com/penwyp/ClaudePreference --skill doc-code-review-report

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-code-review-report
Source: https://github.com/penwyp/ClaudePreference/tree/main/skills/doc-code-review-report
Command: npx skills add https://github.com/penwyp/ClaudePreference --skill doc-code-review-report

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires [], and includes references (resource) components.

What problem does it solve?

This skill helps teams evaluate written requirements, design notes, API docs, or PR texts against the actual codebase to identify inconsistencies, missing behavior, or potential bugs, producing an evidence-backed review report.

Core Features & Use Cases

Evidence-based claims verification: checks user-provided claims against real implementation details, runtimes, and contracts.
Structured review output: outputs a findings report with severity, evidence, and remediation suggestions.
Use Case: When given a design document and a codebase, generate a comprehensive review highlighting logic gaps and contract mismatches.

Quick Start

Provide a document and run a codebase verification to generate an evidence-backed findings report against the repository.

Frequently Asked Questions about doc-code-review-report

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

FAQPage Schema

How do I verify API documentation against the actual codebase implementation?▼

You can verify API documentation against the codebase by providing both to generate an evidence-backed findings report. It checks written claims against real implementation details and runtime contracts, separating confirmed issues from inferences.

What is evidence-based code review for design notes?▼

Evidence-based code review for design notes is the process of identifying and verifying written claims against the actual codebase. It produces a structured findings report covering logic gaps, contract mismatches, and severity with concrete remediation suggestions.

Can I review PR texts and requirements documents against both frontend and backend code?▼

Yes, you can review PR texts and requirements documents against both frontend and backend codebases. The tool evaluates written materials across both component types to identify inconsistencies, missing behavior, or potential bugs in the implementation.

How do I generate a code review report that separates confirmed issues from inferences?▼

Generate a code review report by providing a document and running a codebase verification. The output enforces structured findings with documented evidence, explicitly separating confirmed issues from inferred observations and suggesting concrete remediations.

Does documentation verification work without any external dependencies?▼

Yes, documentation verification works without external dependencies. The skill operates independently to cross-check user-provided documents against the codebase and requires no additional libraries or external modules to produce its findings report.

What's the best way to find logic gaps between a design document and a repository?▼

The best way to find logic gaps between a design document and a repository is to run a codebase verification. It cross-references written requirements against actual implementation details to produce a comprehensive review highlighting mismatches.