What problem does it solve?
Creating accurate and useful repository documentation is often a manual, error-prone process that relies on assumptions. This Skill automates the systematic exploration of a codebase to generate documentation that reflects its actual architecture, tech stack, and code patterns, saving significant time and ensuring accuracy.
Core Features & Use Cases
- Systematic Codebase Exploration: Guides you through a discovery phase to identify the ecosystem, map architecture, extract patterns, and catalog specifics directly from the code.
- Structured Documentation Generation: Creates
CLAUDE.md and docs/claude/ files with sections for architecture, tech stack, patterns, and development, all populated with real code examples.
- "No Documentation Without Reading the Code First" Enforcement: Prevents generic templates and placeholder content, ensuring documentation is always accurate and valuable.
- Use Case: When onboarding a new repository, use this Skill to automatically generate comprehensive documentation by analyzing its actual files, dependencies, and build configurations, saving hours of manual effort and ensuring new team members get up to speed quickly.
Quick Start
Use the onboard-repository skill to generate comprehensive documentation for the current repository, starting with the discovery phase to map its architecture and tech stack.
