# catalog-documentation-creator

Создаёт структуру и файлы документации для EventCatalog: сервисы, события, команды, ADR и схемы данных. Пригодится при описании микросервисной архитектуры в репозитории.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 830 установок · ★ 13
- Автор: eventcatalog
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/event-catalog/skills/tree/HEAD/skills/catalog-documentation-creator/SKILL.md
- Обновлён: 2026-10-19
- HTML: https://affpapa.org/nevibecode/skills/catalog-documentation-creator

## Что делает

Скилл автоматизирует ведение EventCatalog прямо в диалоге с агентом. Сначала он ищет каталог в проекте по файлу `eventcatalog.config.js` или стандартным папкам. Если каталога ещё нет, скилл предложит создать чистую структуру командой `npx @eventcatalog/create-eventcatalog@latest <name> --empty`. При проверке существующего каталога он определяет тип организации файлов — плоский или с вложенностью по доменам.

Инструмент сканирует кодовую базу проекта. Он извлекает сервисы, очереди, события и схемы в форматах JSON Schema или Avro, а также строит диаграммы Mermaid и PlantUML. Если подключён MCP-сервер EventCatalog, скилл вызывает `getResources`, `getResource`, `findResourcesByOwner` и `getSchemaForResource`. Поэтому новые записи сохраняют единый стиль идентификаторов и привязку к командам.

Все созданные файлы скилл сразу записывает в директорию каталога, а не оставляет в окне чата. Для каждого ресурса обязательно формируется валидный YAML-фронтматтер с полями `id`, `name` и версией компонента.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add event-catalog/skills --skill catalog-documentation-creator -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add event-catalog/skills --skill catalog-documentation-creator -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add event-catalog/skills --skill catalog-documentation-creator -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install event-catalog/skills catalog-documentation-creator
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add event-catalog/skills --skill catalog-documentation-creator -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/event-catalog/skills --path skills/catalog-documentation-creator
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add event-catalog/skills --skill catalog-documentation-creator -a opencode
```

### Claude.ai

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

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

## Когда брать
- документировать микросервисы, события и команды для EventCatalog
- развернуть чистую структуру каталога через CLI-генератор
- зафиксировать архитектурные решения (ADR) со связями к сервисам
- описать брокеры сообщений Kafka или RabbitMQ со схемами данных
- выгрузить сущности домена и акторов из существующего исходного кода

## Примеры запросов агенту
- Создай документацию для сервиса заказов и его событий в нашем каталоге EventCatalog
- Опиши очередь RabbitMQ, канал notifications и схему сообщения в формате JSON Schema
- Инициализируй пустой EventCatalog в папке catalog и добавь туда архитектурное решение ADR

## Похожие
- [documentation-and-adrs](https://affpapa.org/nevibecode/skills/documentation-and-adrs.md) — скилл · 63800 установок
- [code-documentation-code-explain](https://affpapa.org/nevibecode/skills/code-documentation-code-explain.md) — скилл · 1000 установок
- [create-architecture-documentation](https://affpapa.org/nevibecode/commands/create-architecture-documentation.md) — команда · 6136 установок
- [documentation-writer](https://affpapa.org/nevibecode/skills/documentation-writer.md) — скилл · 27757 установок
- [design-doc-mermaid](https://affpapa.org/nevibecode/skills/design-doc-mermaid.md) — скилл · 80700 установок
- [architecture-diagram-creator](https://affpapa.org/nevibecode/skills/architecture-diagram-creator.md) — скилл · 453 установки

Из того же набора: [event-catalog/skills](https://affpapa.org/nevibecode/by/event-catalog/skills.md) — 5 карточек

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

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