skill Claude Code
Open on GitHub
codebase-onboarding · alirezarezvani — Claude Code skill: setup and features
Analyzes a repository and generates onboarding documentation for engineers, tech leads, and contractors. Helpful for new hires and project handoffs.
Install into Claude Code · Plugin marketplace
All methods and platforms ↓
/plugin marketplace add alirezarezvani/claude-skills
/plugin install engineering-advanced-skills@claude-code-skillsWhat codebase-onboarding does
The skill runs scripts/codebase_analyzer.py to inspect a repository. It identifies languages and maps top-level project structure. You can export facts directly to JSON.
Outputs follow references/onboarding-template.md and adjust depth by role. Junior engineers get setup steps and guardrails. Senior engineers receive architectural details. Contractor guides highlight scoped ownership and integration boundaries.
Use this skill when preparing handoffs or updating stale documentation after major refactoring.
What it helps with
- generate tailored onboarding docs for different engineering levels
- audit repository structure, languages, and config files
- prepare scoped handoff packets for external contractors
- rebuild stale project architecture docs after refactoring
Example prompts for the agent
- Run scripts/codebase_analyzer.py on this repo and draft setup instructions for a junior engineer.
- Analyze the repository structure and create an architecture overview using references/onboarding-template.md.
- Export codebase facts with --json and prepare handoff docs for a contractor.
How to install codebase-onboarding
1Plugin marketplace
/plugin marketplace add alirezarezvani/claude-skills/plugin install engineering-advanced-skills@claude-code-skillsThis installs the whole engineering-advanced-skills plugin with all its skills
2Skills CLI (Vercel)
npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a claude-code3Manually: put the files in place
~/.claude/skills/codebase-onboarding/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/codebase-onboarding/
Manually: put the files in place
.agents/skills/codebase-onboarding/SKILL.mdFor all projects use ~/.agents/skills/
Manually: put the files in place
.cursor/skills/codebase-onboarding/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install alirezarezvani/claude-skills codebase-onboarding2Manually: put the files in place
.github/skills/codebase-onboarding/SKILL.mdPlatform CLI
gemini skills install https://github.com/alirezarezvani/claude-skills --path engineering/skills/codebase-onboardingManually: put the files in place
.devin/skills/codebase-onboarding/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
From the same set349
The whole set →
engineering-skills An engineering skill index for Claude Code that helps you select one specialist SKILL.md for the task at hand. It covers architecture, testing, DevOps, and data work.
Claude Code
2,387installs
finance-skills Routes ambiguous finance prompts to the right bundled skill: financial-analyst, saas-metrics-coach, or month-end-close.
Claude Code
2,312installs
marketing-skills A directory and router for marketing skills in Claude Code. It picks the right specialist skill for SEO, content, CRO, channels, and related tasks.
Claude Code
2,264installs
business-growth-skills Routes growth and revenue prompts to the right specialized skill across customer success, sales engineering, RevOps, and proposals in Claude Code.
Claude Code
2,189installs
engineering-advanced-skills An index of 37 engineering skills for architecture, automation, reliability, and platform work. Use it when a project needs task-specific engineering workflows.
Claude Code
2,019installs
product-skills Product work orchestrator for Claude Code. Routes queries across 16 domain lanes and validates discovery trees with deterministic scripts.
Claude Code
1,994installs
pm-skills Routes project-delivery requests across 8 PM sub-skills for Jira, Confluence, sprints, reporting, and team communication. Useful for controlled delivery work.
Claude Code
1,975installs
senior-backend Scaffolds backend APIs, detects database bottlenecks, and runs load tests. Useful when designing Express routes, optimizing PostgreSQL, or preparing for production.
Claude Code
1,674installs
Other versions of codebase-onboarding
Similar
grill-with-docs This skill interviews you about a plan or design and creates ADRs and a glossary along the way. Use it when decisions need sharper definition.
Claude Code
1,219,756installs
skill-creator
official Creates and refines skills, then tests them with prompts, evaluations, and performance checks.
Claude Code Claude.ai
414,180installs
setup-matt-pocock-skills This skill configures a repository for Matt Pocock's engineering skills by setting its issue tracker, triage labels, and domain docs layout. Run it before using the other skills.
Claude Code
1,052,851installs
handoff Creates a handoff document from the current conversation so another agent can continue the work. Use it when a task moves to a new session or agent.
Claude Code
1,038,491installs
triage This skill moves issues and external PRs through triage states, verification, and agent briefs. It fits maintainers managing an issue queue.
Claude Code
990,453installs
domain-modeling This skill sharpens project terminology, maintains GLOSSARY.md, and records selected architecture decisions in ADRs. Use it while the domain model is changing.
Claude Code
876,391installs
Questions about codebase-onboarding
How to install codebase-onboarding in Claude Code?
Run /plugin marketplace add alirezarezvani/claude-skills or install it with npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a claude-code.
What does codebase-onboarding do?
It examines repository signals with a Python analyzer script and structures onboarding documentation tailored to engineers, leads, or contractors.
How does it adapt output for different audiences?
Junior outputs focus on setup and guardrails, senior guides target architecture, and contractor documentation defines scoped integration boundaries.
Source text
SKILL.md · MIT
--- name: "codebase-onboarding" description: "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." --- # 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. Capture key signals: file counts, detected languages, config files, top-level structure. 3. Fill the onboarding template in `references/onboarding-template.md`. 4. Tailor output depth by audience: - Junior: setup + guardrails - Senior: architecture + operational concerns - Contractor: scoped ownership + integration boundaries --- ## Onboarding Document Template Detailed template and section examples live in: - `references/onboarding-template.md` - `references/output-format-templates.md` --- ## Common Pitfalls - Writing docs without validating setup commands on a clean environment - Mixing architecture deep-dives into contractor-oriented docs - Omitting troubleshooting and verification steps - Letting onboarding docs drift from current repo state ## Best Practices 1. Keep setup instructions executable and time-bounded. 2. Document the "why" for key architectural decisions. 3. Update docs in the same PR as behavior changes. 4. Treat onboarding docs as living operational assets, not one-time deliverables.
© Alireza Rezvani · MIT · alirezarezvani/claude-skills
