codebase-onboarding

Solid

Codebase Onboarding

AI & Automation 16,392 stars 2261 forks Updated today 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
today
Language
Python
License
MIT

Integrates with

Related Skills