api-documentation-verify

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.