codebase-documentation-audit
CommunityAutomate documentation audits and fill knowledge gaps.
Software Engineering#automation#documentation#technical writing#codebase analysis#code audit#API docs
Authorvasilyu1983
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Undocumented codebases lead to slower onboarding, increased bugs, and compliance risks. Manually auditing documentation is tedious and often incomplete. This Skill automates the discovery of documentation gaps and helps generate missing docs.
Core Features & Use Cases
- Systematic Audit: Scans APIs, services, events, database schemas, and configurations to identify undocumented components.
- Coverage Reporting: Generates comprehensive documentation coverage reports, highlighting critical gaps by priority.
- Automated Generation: Leverages documentation templates to create missing documentation, ensuring consistency and completeness.
Quick Start
Use the codebase-documentation-audit skill to audit my Node.js codebase for undocumented APIs and generate a coverage report.
Dependency Matrix
Required Modules
None requiredComponents
referencesassets
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: codebase-documentation-audit Download link: https://github.com/vasilyu1983/AI-Agents-public/archive/main.zip#codebase-documentation-audit Please download this .zip file, extract it, and install it in the .claude/skills/ directory.