codebase-onboarding
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.
Profile →npx skills add alirezarezvani/claude-skills --skill codebase-onboarding --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# Codebase Onboarding **Tier:** POWERFUL **Category:** Engineering **Domain:** Documentation / Developer Experience --- ## Overview 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 ```bash # 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 1. Run `scripts/codebase_analyzer.py` against the target repository. 2. Cap
- Overview
- Core Capabilities
- When to Use
- Quick Start
- Recommended Workflow
- Onboarding Document Template
- Common Pitfalls
- Best Practices
python3 scripts/codebase_analyzer.py /path/to/repo python3 scripts/codebase_analyzer.py /path/to/repo --json See references/onboarding-template.md
What does the codebase-onboarding skill do?
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.
How do I install it?
Run `npx skills add alirezarezvani/claude-skills --skill codebase-onboarding --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From alirezarezvani/claude-skills, a repository with 23,791 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.