api-documentation-verify

Verify API documentation against source code for accuracy and runnable examples.

Updated Aug 27, 2026

Search Tags:#code quality #testing #documentation #api #verification #accuracy

Ready to run

npx skills add https://github.com/meriley/claude-code-skills --skill api-documentation-verify

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-documentation-verify
Source: https://github.com/meriley/claude-code-skills/tree/main/skills/api-documentation-verify
Command: npx skills add https://github.com/meriley/claude-code-skills --skill api-documentation-verify

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill eliminates fabricated API methods, unverified performance claims, non-runnable code examples, and marketing language in API documentation, ensuring accuracy and reliability.

Core Features & Use Cases

API Method Verification: Confirms every documented API method exists in the source code with the correct signature.
Code Example Validation: Ensures all code examples are runnable and accurate.
Performance Claim Validation: Verifies that performance claims are supported by benchmarks.
Use Case: Before merging documentation changes for a new API endpoint, run this skill to guarantee that the documented parameters, return types, and code examples precisely match the implementation, preventing developer confusion and integration issues.

Quick Start

Run the api-documentation-verify skill to check all documentation files in the current directory for accuracy against the source code.

Frequently Asked Questions about api-documentation-verify

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

FAQPage Schema

How do I verify API documentation against source code?▼

Verify API documentation against source code by reading source files and comparing documented methods, signatures, and examples against the actual implementation to ensure accuracy and eliminate fabricated claims.

What problems does API documentation verification solve?▼

API documentation verification solves the problem of fabricated API methods, unverified performance claims, non-runnable code examples, and marketing language, ensuring documentation accurately reflects the source code implementation.

How do I check markdown documentation for fabricated API methods?▼

Check markdown documentation for fabricated API methods by comparing documented API methods against source code to confirm every method exists with the correct signature, validating parameters and return types.

How do I validate code examples in API documentation are runnable?▼

Validate code examples in API documentation by comparing them against the source code implementation to ensure all examples are runnable, accurate, and match the actual API signatures.

When do I need to verify API documentation accuracy?▼

Verify API documentation accuracy before merging documentation changes for a new API endpoint to guarantee documented parameters, return types, and code examples match the implementation, preventing developer confusion.

Can I verify performance claims in API documentation against benchmarks?▼

Verify performance claims in API documentation by checking that stated performance metrics are supported by actual benchmarks, eliminating unverified claims and marketing language from the documentation.