| name | api-documentation-verify |
| description | Verifies API documentation against source code to eliminate fabricated claims, ensure accuracy, and validate examples. Zero tolerance for unverified claims, marketing language, or non-runnable code examples. Use before committing API docs or during documentation reviews. |
| version | 1.0.0 |
API Documentation Verification Skill
Purpose
Verify API documentation accuracy against source code. This skill eliminates fabricated API methods, unverified performance claims, non-runnable code examples, and marketing language. Every documented feature must exist in the codebase.
Quick Start
Use this skill to verify:
- API methods exist with correct signatures
- Code examples are runnable and accurate
- Performance claims have benchmark support
- Configuration options match source code
- Error documentation matches thrown errors
- Marketing language is removed
- Dependencies match package.json
Verification Categories (Summary)
CRITICAL (Must Fix Before Commit)
- API Method Existence: Every documented method must exist in source with exact signature
- Parameter/Return Types: Types must exactly match implementation (no guessing)
- Code Examples: All examples must be runnable with proper imports and error handling
- Performance Claims: ZERO tolerance for unverified claims - require benchmarks