# codebase-documenter

Скилл codebase-documenter для Claude Code пишет документацию по репозиторию: README, описание архитектуры, гайд для новичков, API и комментарии в коде. Помогает объяснить проект новому разработчику.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 145 установок · ★ 114 у репозитория
- Автор: travisjneuman
- Лицензия: MIT · policy=mirror · лицензия открытая, файл — в исходнике
- Исходник: https://github.com/travisjneuman/.claude/tree/HEAD/skills/codebase-documenter/SKILL.md
- Обновлён: 2026-11-10
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/travisjneuman-codebase-documenter

## Что делает

Скилл проходит по репозиторию и собирает документацию: точки входа, зависимости, конфигурацию, ключевые абстракции. Дальше выбирает тип документа по порядку README, архитектура, API, комментарии, заполняет шаблоны под проект и прогоняет проверку. Перед текстом он всегда объясняет, зачем код нужен, и только потом как он работает.

Внутри набор шаблонов: README с быстрым стартом и деревом файлов, страница архитектуры с потоком данных и разделом про принятые решения, формат ADR с компромиссами, примеры хороших и плохих комментариев. Отдельно лежит чек-лист перед публикацией: примеры копипастятся, пути и ссылки верные, жаргон расшифрован. И список типичных провалов вроде устаревших примеров или пропущенных требований.

Верификация здесь — чтение: скилл сверяет примеры с текущим кодом и путями, но не запускает их. Сломанный по синтаксису пример такую проверку пройдёт. Ревью кода, UX-решения и новые фичи он не берёт и отправляет к `generic-code-reviewer`, `generic-ux-designer` и `generic-feature-developer`.

## Установка

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

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

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add travisjneuman/.claude --skill codebase-documenter -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add travisjneuman/.claude --skill codebase-documenter -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install travisjneuman/.claude skills/codebase-documenter
```

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

### Gemini CLI

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

2. **Командой платформы**
```bash
gemini skills install https://github.com/travisjneuman/.claude --path skills/codebase-documenter
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add travisjneuman/.claude --skill codebase-documenter -a opencode
```

### Claude.ai

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

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

## Когда брать
- написать README, по которому проект запускается за 5 минут
- описать архитектуру и показать поток данных диаграммой
- задокументировать эндпоинты с примерами запроса и ответа
- переписать комментарии так, чтобы они объясняли причину, а не повторяли код
- прогнать готовую документацию по чек-листу перед публикацией

## Примеры запросов агенту
- Задокументируй проект: собери README с быстрым стартом и деревом файлов
- Опиши архитектуру `src/services` и покажи, как данные идут от формы до базы
- Оформи эндпоинты из `api/routes.ts` как API-документацию с примерами

## Похожие
- [doc-forge](https://affpapa.org/nevibecode/plugins/doc-forge.md) — плагин · ★ 2858 у репозитория
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10800 установок
- [documentation-engineer](https://affpapa.org/nevibecode/skills/documentation-engineer.md) — скилл · 722 установки
- [code-documentation-analyzer](https://affpapa.org/nevibecode/skills/code-documentation-analyzer.md) — скилл · 1 установка
- [documentation-templates](https://affpapa.org/nevibecode/skills/documentation-templates.md) — скилл · 305 установок
- [gem-documentation-writer](https://affpapa.org/nevibecode/agents/gem-documentation-writer.md) — субагент · ★ 41430 у репозитория

## Другие версии с тем же именем
- [codebase-documenter · ailabs-393](https://affpapa.org/nevibecode/skills/codebase-documenter.md) — 1500 установок
- [codebase-documenter · mhattingpete](https://affpapa.org/nevibecode/skills/mhattingpete-codebase-documenter.md) — 595 установок

Из того же набора: [travisjneuman/.claude](https://affpapa.org/nevibecode/by/travisjneuman/.claude.md) — 117 карточек

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