codebase-onboarding

alirezarezvani/claude-skills · .gemini/skills/codebase-onboarding/SKILL.md

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.

No license★ 25441⑂ 3598commit 19392f7

Install skillView source on GitHub

What this skill does

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

# 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.
Capture key signals: file counts, detected languages, config files, top-level structure.
Fill the onboarding template in references/onboarding-template.md.
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

Keep setup instructions executable and time-bounded.
Document the "why" for key architectural decisions.
Update docs in the same PR as behavior changes.
Treat onboarding docs as living operational assets, not one-time deliverables.

Installation

Copy a source-pinned command for your client. You run it yourself.

Destination: .claude/skills/codebase-onboarding · pinned to the source commit

# Run from your project root
git clone https://github.com/alirezarezvani/claude-skills.git .skillboard-tmp
git -C .skillboard-tmp checkout 19392f7a08264ed00486a251f5b2098321771f94
mkdir -p ".claude/skills"
cp -r ".skillboard-tmp/.gemini/skills/codebase-onboarding" ".claude/skills/"
rm -rf .skillboard-tmp

Review the source before running. This copies files into your project; it is not a one-click install and does not verify runtime safety.

New here? Step-by-step setup – from installing the agent to using the skill

Operating systemAgentI already use Claude Code

1
Install Git
Install Git with your package manager (Debian/Ubuntu shown; use dnf/pacman on others). Official download.
```
sudo apt update && sudo apt install -y git
```
2
Install Claude Code
Requires Node.js 18+. Install the CLI globally: Official docs. (command-line tool)
```
npm install -g @anthropic-ai/claude-code
```

Get the skill, pinned to its exact version

Open a terminal and run these steps (they clone the source, check out the exact commit, and copy the skill into place):

# Run from your project root
git clone https://github.com/alirezarezvani/claude-skills.git .skillboard-tmp
git -C .skillboard-tmp checkout 19392f7a08264ed00486a251f5b2098321771f94
mkdir -p ".claude/skills"
cp -r ".skillboard-tmp/.gemini/skills/codebase-onboarding" ".claude/skills/"
rm -rf .skillboard-tmp

Destination: .claude/skills/codebase-onboarding

4
Use it in Claude Code
Open Claude Code in your project. It reads skills from the folder above, so codebase-onboarding is now available. Always review the source before using it – static checks cannot prove runtime safety.

Security & Audits

Scanner static-checks@0.1.0 · commit 19392f7a0826. Static checks cannot prove runtime safety – review the source and the exact diff before installing. How checks work.

No static rules matched. This is not a safety guarantee.

codebase-onboarding

alirezarezvani/claude-skills · .gemini/skills/codebase-onboarding/SKILL.md

No license★ 25441⑂ 3598commit 19392f7

What this skill does

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

# 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.
Capture key signals: file counts, detected languages, config files, top-level structure.
Fill the onboarding template in references/onboarding-template.md.
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

Keep setup instructions executable and time-bounded.
Document the "why" for key architectural decisions.
Update docs in the same PR as behavior changes.
Treat onboarding docs as living operational assets, not one-time deliverables.

Installation

Copy a source-pinned command for your client. You run it yourself.

Destination: .claude/skills/codebase-onboarding · pinned to the source commit

# Run from your project root
git clone https://github.com/alirezarezvani/claude-skills.git .skillboard-tmp
git -C .skillboard-tmp checkout 19392f7a08264ed00486a251f5b2098321771f94
mkdir -p ".claude/skills"
cp -r ".skillboard-tmp/.gemini/skills/codebase-onboarding" ".claude/skills/"
rm -rf .skillboard-tmp

Review the source before running. This copies files into your project; it is not a one-click install and does not verify runtime safety.

New here? Step-by-step setup – from installing the agent to using the skill

Operating systemAgentI already use Claude Code

1
Install Git
Install Git with your package manager (Debian/Ubuntu shown; use dnf/pacman on others). Official download.
```
sudo apt update && sudo apt install -y git
```
2
Install Claude Code
Requires Node.js 18+. Install the CLI globally: Official docs. (command-line tool)
```
npm install -g @anthropic-ai/claude-code
```

Get the skill, pinned to its exact version

Open a terminal and run these steps (they clone the source, check out the exact commit, and copy the skill into place):

# Run from your project root
git clone https://github.com/alirezarezvani/claude-skills.git .skillboard-tmp
git -C .skillboard-tmp checkout 19392f7a08264ed00486a251f5b2098321771f94
mkdir -p ".claude/skills"
cp -r ".skillboard-tmp/.gemini/skills/codebase-onboarding" ".claude/skills/"
rm -rf .skillboard-tmp

Destination: .claude/skills/codebase-onboarding

4
Use it in Claude Code
Open Claude Code in your project. It reads skills from the folder above, so codebase-onboarding is now available. Always review the source before using it – static checks cannot prove runtime safety.

Security & Audits

Scanner static-checks@0.1.0 · commit 19392f7a0826. Static checks cannot prove runtime safety – review the source and the exact diff before installing. How checks work.

No static rules matched. This is not a safety guarantee.

codebase-onboarding

What this skill does

Codebase Onboarding

Overview

Core Capabilities

When to Use

Quick Start

Recommended Workflow

Onboarding Document Template

Common Pitfalls

Best Practices

Installation

Install Git

Install Claude Code

Get the skill, pinned to its exact version

Use it in Claude Code

Security & Audits

codebase-onboarding

What this skill does

Codebase Onboarding

Overview

Core Capabilities

When to Use

Quick Start

Recommended Workflow

Onboarding Document Template

Common Pitfalls

Best Practices

Installation

Install Git

Install Claude Code

Get the skill, pinned to its exact version

Use it in Claude Code

Security & Audits