codebase-documenter
CommunityAuto-generate developer docs for codebases.
AuthorPedroGiudice
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill creates comprehensive documentation explaining how a codebase works, including architecture, key components, data flow, and development guidelines to speed onboarding and reduce ramp-up time.
Core Features & Use Cases
- Project Overview: purpose, tech stack, status, and target users.
- Architecture: high-level structure, data flow, and design decisions.
- Directory Structure: organization, entry points, and core modules.
- Key Components: classes, interactions, and code examples.
- Development Setup & Guidelines: setup steps, testing, and contribution basics.
Quick Start
Run the tool to generate documentation:
python codebase_documenter.py --path /path/to/codebase --output docs/
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 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-documenter Download link: https://github.com/PedroGiudice/Claude-Code-Projetos/archive/main.zip#codebase-documenter Please download this .zip file, extract it, and install it in the .claude/skills/ directory.