Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. Fast fact-gathering and repeatable onboarding outputs. Use when onboarding a new engineer, writing architecture-overview docs for a new project, or producing tech-lead briefings for unfamiliar repos.
Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. Fast fact-gathering and repeatable onboarding outputs. Use when onboarding a new engineer, writing architecture-overview docs for a new project, or producing tech-lead briefings for unfamiliar repos.
Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. This skill is optimized for fast fact-gathering and repeatable onboarding outputs.
Core Capabilities
Architecture and stack discovery from repository signals
Key file and config inventory for new contributors
Local setup and common-task guidance generation
Audience-aware documentation framing
Debugging and contribution checklist scaffolding
When to Use
Onboarding a new team member or contractor
Rebuilding stale project docs after large refactors
Preparing internal handoff documentation
Creating a standardized onboarding packet for services
Quick Start
# 1) Gather codebase facts
python3 scripts/codebase_analyzer.py /path/to/repo
# 2) Export machine-readable output
python3 scripts/codebase_analyzer.py /path/to/repo --json
# 3) Use the template to draft onboarding docs# See references/onboarding-template.md
Recommended Workflow
Run scripts/codebase_analyzer.py against the target repository.
