codebase-onboarding

Solid

Codebase Onboarding

AI & Automation 16,782 stars 2310 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 92/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 -...

Details

Author
alirezarezvani
Repository
alirezarezvani/claude-skills
Created
7 months ago
Last Updated
3 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

codebase-onboarding

Auto-generate onboarding documentation from codebase analysis, tailored to the reader's experience level. TRIGGER when: user asks to onboard someone to a codebase, document this codebase, generate project documentation for new team members, write a codebase walkthrough or tour, create a getting-started guide, or explain a codebase to a specific audience. DO NOT TRIGGER when: user wants API reference docs (use language-specific tooling), or wants to understand a single file (just read it).

1 Updated 1 weeks ago
DROOdotFOO
AI & Automation Listed

codebase-onboarding

Fast repo reconnaissance and onboarding workflow for unfamiliar codebases. Use when joining a project or building a starter CLAUDE.md.

0 Updated today
JunMystery
AI & Automation Solid

codebase-onboarding

Analyze an unfamiliar codebase and generate a structured onboarding guide with architecture map, key entry points, conventions, and a starter CLAUDE.md. Use when joining a new project or setting up Claude Code for the first time in a repo.

201,447 Updated yesterday
affaan-m
Data & Documents Listed

codebase-documenter

Use this skill when the user wants to understand, document, or explain a codebase — even if they don't say "document" explicitly. Trigger on: "explain this codebase", "how does this project work", "create onboarding docs", "document the architecture", "I'm new to this repo", "generate a codebase overview", or any request to understand unfamiliar code. Produces a single docs/CODEBASE.md with architecture, components, data flow, setup instructions, and a recommended reading path for new developers. Supports quick/standard/deep depth levels and incremental updates.

1 Updated 4 days ago
opencue
Data & Documents Listed

codebase-documenter

Use this skill when the user wants to understand, document, or explain a codebase — even if they don't say "document" explicitly. Trigger on: "explain this codebase", "how does this project work", "create onboarding docs", "document the architecture", "I'm new to this repo", "generate a codebase overview", or any request to understand unfamiliar code. Produces a single docs/CODEBASE.md with architecture, components, data flow, setup instructions, and a recommended reading path for new developers. Supports quick/standard/deep depth levels and incremental updates.

1 Updated 1 weeks ago
opencue