Codebase Onboarding

SkillAI & models

This skill lets your AI analyze a codebase and turn what it finds into onboarding documentation. Once added, your AI can produce docs for new engineers, contractors, and tech leads, including architecture overviews and briefings for unfamiliar repositories.

Available today. Use it from your connected AI after setup.

No other account needed.

After adding it, point your AI at the codebase you want documented and tell it who the docs are for, such as a new engineer or a tech lead.

Then ask your AI: use the Codebase Onboarding skill

What your AI can do with it

Analyze an unfamiliar codebase and gather the key facts quickly
Generate onboarding documentation for new engineers
Write architecture-overview docs for a new project
Produce briefings for tech leads on unfamiliar repositories
Create onboarding materials suited to contractors
Repeat the same onboarding output each time so docs stay consistent

What this skill tells your AI

The instructions your AI receives, as published by affaan-m/ecc in skills/codebase-onboarding/SKILL.md and read by ahel’s review.

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