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 today 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
today
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

brain-onboard

Onboard any project into the Second Brain system (Claude Code + Obsidian vault). Invoke in any chat — the skill scans conversation context, asks only for missing info, and generates a ready-to-use package: CLAUDE.md (fully filled), _PROJECT.md, taskboard.md, a setup script, and — for code projects — an architecture map. Use when transitioning a project from chat to Claude Code, connecting an existing project to the vault, or starting a new project with full context.

0 Updated yesterday
dmitrax
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 Solid

project-onboarding

Full project onboarding for Claude Cowork: generates context.md, folder-instructions.md, file map, and starter prompts in one session. Triggers RU: «создай проект», «onboarding проекта», «новый проект», «настрой проект», «создай контекст проекта», «быстрый контекст», «обнови карту файлов», «пересканируй файлы». Triggers EN: 'create project', 'project onboarding', 'new project', 'set up project', 'quick context', 'update file map', 'rescan files'.

14 Updated today
KirKruglov