docs
Auto-generate README and API documentation from code analysis
When & Why to Use This Skill
This Claude skill automates the creation of comprehensive README files and API documentation through intelligent code analysis. By scanning codebase structures and extracting public APIs, type definitions, and configurations, it ensures your project documentation remains accurate, professional, and perfectly synchronized with your source code using consistent Markdown formatting.
Use Cases
- Project Bootstrapping: Rapidly generate professional README.md files including installation guides, quick-start instructions, and project overviews for new repositories.
- Automated API Reference: Extract JSDoc/TSDoc comments, function signatures, and module exports to create detailed API documentation without manual entry.
- Codebase Onboarding: Produce structured documentation for complex modules to help new team members understand architecture, types, and usage patterns quickly.
- Documentation Maintenance: Keep technical manuals up-to-date by re-running analysis after major code changes to reflect updated configurations and API endpoints.
| name | docs |
|---|---|
| description | Auto-generate README and API documentation from code analysis |
| allowed-tools | Read, Glob, Grep, Write |
Documentation Generator
Generate comprehensive documentation by analyzing code.
Process
- Analyze: Scan codebase structure
- Extract: Identify public APIs, types, configs
- Generate: Create documentation
- Format: Apply consistent Markdown styling
Output Types
README.md
- Project overview
- Installation
- Quick start
- API summary
- Configuration
API Docs
- Module descriptions
- Function signatures
- Type definitions
- Usage examples
Conventions
- Use JSDoc/TSDoc comments in source
- Markdown for all docs
- Code blocks with language hints
- Table of contents for long docs
Example Usage
claudetree start --template docs "Generate documentation for the auth module"
claudetree start --skill docs "Document the API endpoints"