# codebase-onboarding

Скилл codebase-onboarding для Claude Code собирает факты о кодовой базе и готовит документацию для онбординга: обзор архитектуры, карту ключевых файлов, гайд по запуску и справочник по отладке.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 117 установок · ★ 1183 у репозитория
- Автор: borghei
- Лицензия: LicenseRef-MIT-Commons-Clause · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/borghei/Claude-Skills/tree/HEAD/engineering/codebase-onboarding/SKILL.md
- Обновлён: 2026-11-08
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/borghei-codebase-onboarding

## Что делает

Внутри три Python-скрипта: `onboarding_generator.py` читает манифесты и локфайлы, собирает стек, точки входа, ключевые файлы и переменные окружения, потом генерирует черновик документации с метками `> **TODO (owner):**` там, где агент не может ответить сам. `architecture_mapper.py` определяет паттерн проекта — монорепо, микросервисы, MVC, слоистая архитектура — и расписывает роли директорий. `setup_validator.py` проверяет README, `.env`-шаблон, локфайл, CI, конфиг линтера, тесты и лицензию, выставляет оценку от 0 до 100 и показывает, что починить.

Выходной формат — Markdown, Notion или Confluence. Глубина подачи меняется в зависимости от аудитории: джуниор, старший инженер или подрядчик получают разные секции. Черновик из `onboarding_generator.py` не финал: скилл явно говорит об этом и оставляет TODO-метки на всё, что нужно перепроверить руками или уточнить у владельцев.

Если `setup_validator.py` выдаёт низкий балл, гайд по настройке будет неполным — потому что скрипт нашёл реальные пробелы в репозитории. Код расположен в `scripts/`, шаблоны документации — в `references/documentation-templates.md`. Для пошагового тура по коду (остановка за остановкой) скилл отсылает к `engineering/code-tour`.

## Установка

### Claude Code (родная платформа)

1. **Через Skills CLI (Vercel)**
```bash
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/codebase-onboarding/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/codebase-onboarding/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/codebase-onboarding/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/codebase-onboarding/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install borghei/Claude-Skills engineering/codebase-onboarding/SKILL.md
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/codebase-onboarding/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/borghei/Claude-Skills --path engineering/codebase-onboarding
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/codebase-onboarding/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/borghei/Claude-Skills/tree/HEAD/engineering/codebase-onboarding/SKILL.md

## Когда брать
- сгенерировать черновик онбординговой документации после крупного рефакторинга
- проверить полноту настройки репозитория перед открытием в open-source
- составить карту ключевых файлов для нового инженера в команде
- создать отладочный справочник с реальными сообщениями об ошибках
- подготовить документацию по сервису перед отпуском или сменой команды

## Примеры запросов агенту
- Проанализируй кодовую базу в `/path/to/project` и сгенерируй онбординговый гайд в формате Markdown для джуниор-разработчика
- Запусти `setup_validator.py` на текущем проекте и покажи, какие пробелы мешают честному гайду по настройке
- Собери карту ключевых файлов: точки входа, конфиг-хабы и файлы, которые нельзя трогать без координации

## Похожие
- [codebase-documenter](https://affpapa.org/nevibecode/skills/mhattingpete-codebase-documenter.md) — скилл · 595 установок
- [wiki-onboarding](https://affpapa.org/nevibecode/skills/wiki-onboarding.md) — скилл · 5 установок
- [codebase-summarizer](https://affpapa.org/nevibecode/skills/codebase-summarizer.md) — скилл · 411 установок
- [c4-codebase-architecture](https://affpapa.org/nevibecode/skills/c4-codebase-architecture.md) — скилл · ★ 24 у репозитория
- [Documentation Architect](https://affpapa.org/nevibecode/skills/documentation-architect.md) — скилл · 1 установка

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
