API Documentation Auditor

•
47
•

Audits API documentation to identify discrepancies between code implementation and documentation while optimizing for developer experience.

The Guide Audit skill acts as a specialized API Documentation Engineer within Claude Code to ensure your technical documentation remains accurate and useful. It systematically cross-references your API specifications and documentation against the actual source code to uncover missing parameters, undocumented error codes, and stale examples. By identifying gaps between documentation and reality, this skill helps teams reduce developer friction and technical debt through a prioritized list of actionable fixes and structural improvements.

Características Principales

01Validates the accuracy and relevance of existing code examples
02Detects undocumented parameters, response fields, and error codes
0347 GitHub stars
04Analyzes documentation structure to improve developer time-to-value
05Identifies discrepancies between API specs and source code implementation
06Provides a prioritized roadmap for documentation updates and fixes

Casos de Uso

01Identifying technical debt in documentation after major refactoring
02Improving developer onboarding by ensuring tutorials match current code behavior
03Conducting pre-release documentation reviews for new API versions