How does it notify me of changes?

After the audit, the skill generates a detailed summary report that can be posted to a GitHub issue, outlining exactly which files were created or updated.

Which API frameworks does this skill support?

The skill can automatically detect and extract endpoints from Express, Fastify, NestJS, FastAPI, Flask, and Go projects.

Can it validate my documentation files?

Yes, it uses tools like yq and jq to validate YAML and JSON files, ensuring that the generated OpenAPI specs are syntactically correct.

What is documentation drift?

Documentation drift happens when software features or API endpoints are updated in the code, but the corresponding documentation remains unchanged, leading to inaccurate guides.

Does this skill delete my existing documentation?

No, it is designed to analyze existing files and intelligently append or update information, using placeholders to indicate where manual review is required.

Documentation Auditor

Name: Documentation Auditor
Author: troykelly

bytroykelly

•

학습 및 문서화

Automatically synchronizes API specifications and feature guides with the codebase to eliminate documentation drift.

The Documentation Audit skill is a specialized utility designed to ensure that project documentation accurately reflects the underlying source code. It systematically scans repositories for API endpoints, UI features, and configuration flags across various frameworks like Express, NestJS, FastAPI, and Go. When 'drift' is detected—where the code has changed but documentation has not—the skill automatically generates or updates OpenAPI (Swagger) specifications and Markdown feature guides. It includes a validation phase to ensure schema integrity and provides a comprehensive audit report for final developer review.

주요 기능

01Automated generation of OpenAPI 3.0.3 specifications

02Feature discovery through UI component and configuration analysis

03Automatic framework detection for Node.js, Python, and Go

04Comprehensive extraction of API endpoints and request/response schemas

05Validation of generated YAML and Markdown documentation

065 GitHub stars

사용 사례

01Generating a new features.md guide for undocumented repositories

02Synchronizing Swagger documentation after significant backend refactors

03Running scheduled audits to ensure documentation stays updated with code changes

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add troykelly/claude-skills documentation-audit

For use in Claude.ai and ChatGPT

Download Skill