project-onboarding

Solid

Scan an unfamiliar codebase, generate CLAUDE.md + OVERVIEW.md, and capture domain knowledge that code alone can't tell you. This skill should be used when the user wants to understand a new project, onboard onto a codebase, set up project documentation, create or update CLAUDE.md, or map project architecture. Common triggers include "what does this project do", "help me get started", "I just joined this repo", "document this codebase", "set up dev docs". Also applies when working on any unfamiliar or inherited project, even without an explicit onboarding request — if the user seems lost in a new codebase, this skill can help.

AI & Automation 3 stars 0 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 79/100

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

Skill Content

# Project Onboarding You are a systematic project onboarding specialist. You help users understand unfamiliar codebases by scanning structure, generating layered documentation, and capturing domain knowledge that cannot be derived from code alone. ## Core Principle > **Code is fact, documentation is claim.** When they conflict, you surface > the conflict and the user designates the single source of truth. > You never decide on your own. ## Responsibility Boundaries ### Two Zones — Source Zone vs Doc Zone **Source Zone (read-only):** All project source code, config files, scripts, and existing business docs. You read and analyze these to extract facts — but never modify them, because changing source during onboarding would be out of scope and risky. **Doc Zone (write with user approval):** Files this skill generates or takes over: - `CLAUDE.md` (root + per-microservice-module) - `AGENTS.md` (root + per-microservice-module) - `README.md` (root + per-microservice-module) — **only-if-missing** policy - `docs/OVERVIEW.md` - Phase 2b governance docs: `docs/architecture-traps.md` (append-only), `docs/TRUTH_SOURCES.md`, `docs/QUICK_REFERENCE.md`, `docs/references/*-{ref,truth-source}.md`, and `docs/{plans,ops,archive}/.gitkeep` - memory files `README.md` and `architecture-traps.md` are governed by the **Existing File Policy** below. You write or edit these after the user reviews the content and the security check passes. Full naming / placement / layering rules are define...

Details

Author
Wubabalala
Repository
Wubabalala/claude-skills
Created
4 months ago
Last Updated
yesterday
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Listed

codebase-onboarding

Generates a single, deeply researched ONBOARDING.md at the root of an open source (or internal) codebase, written for a brand-new contributor. Use this whenever someone wants to understand, explore, ramp up on, or document an unfamiliar repository — trigger phrases include "help me understand this codebase," "explain this repo," "onboard me to this project," "I just cloned this and I'm lost," "write an ONBOARDING.md," "what's the architecture here," "how is this repo organized," or any request to explain a project's purpose, tech stack, dependencies, architecture, or module layout. Also use it proactively whenever a user opens or references a repository they haven't worked in before and asks broad "what is this / how does this work" questions. Do NOT use this for narrow single-file explanations, API reference generation, or README-writing for a project the user is authoring themselves (that's promotional copy, not onboarding).

4 Updated today
kaizakin
AI & Automation Solid

core-codebase-onboarding

Structured codebase orientation workflow for {{PROJECT_NAME}}. Produces an actionable mental map — entry points, dependency graph, architectural layers, hot-path identification, and a recommended reading order — before any modification work begins. Invoked via the /onboard <path> slash command or directly by any agent that must reason about an unfamiliar codebase.

3 Updated today
Canhada-Labs
AI & Automation Listed

onboard

Interactive onboarding for new Claude Code users. Interviews the user about their role, projects, preferences, and tools, then scaffolds their entire AI workspace — knowledge base, memory system, profile, settings, and folder structure. Run once on first setup. Triggers on 'onboard', 'set up my workspace', 'first time setup', 'get started'.

2 Updated today
liormesh