# database-schema-documentation

Скилл помогает документировать схемы баз данных, строить ERD-диаграммы в Mermaid и описывать ограничения таблиц. Пригодится при проектировании архитектуры и подготовке спецификаций миграций.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 569 установок · ★ 371
- Автор: aj-geddes
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/database-schema-documentation/SKILL.md
- Обновлён: 2026-03-04
- HTML: https://affpapa.org/nevibecode/skills/database-schema-documentation

## Что делает

Скилл задаёт формат для документирования структуры реляционных баз данных. Он формирует Markdown-отчёты с метаданными схемы: версией, датой изменения, кратким описанием назначения и ERD-диаграммами в синтаксисе Mermaid.

Внутри заложены правила детального описания сущностей. Инструкция требует выносить таблицы в отдельные файлы каталога `references/`, фиксировать внешние ключи, типы перечислений enum и структуры полей JSONB. Также шаблон обязывает описывать индексы, триггеры, функции и скрипты миграций.

Без фиксации версий схемы и точных типов данных отслеживать изменения между релизами будет трудно. Скилл требует явного заполнения ограничений и структуры сложных типов, поэтому на скорую руку набросать черновик не выйдет.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill database-schema-documentation -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill database-schema-documentation -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill database-schema-documentation -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install aj-geddes/useful-ai-prompts database-schema-documentation
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill database-schema-documentation -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/aj-geddes/useful-ai-prompts --path skills/database-schema-documentation
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill database-schema-documentation -a opencode
```

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/database-schema-documentation/SKILL.md

## Когда брать
- Описать связи между таблицами и построить ERD-диаграмму в формате Mermaid
- Составить словарь данных с точными типами колонок и перечислениями
- Зафиксировать структуру полей JSONB, индексы и ограничения таблицы
- Подготовить спецификацию схемы для проведения миграции

## Примеры запросов агенту
- Составь документацию схемы PostgreSQL для каталога товаров и заказов с ERD-диаграммой
- Опиши структуру таблицы `users` с индексами, ограничениями и примерами данных
- Сделай словарь данных для таблиц платежей, включая перечисления enum и поля JSONB

## Похожие
- [xlsx](https://affpapa.org/nevibecode/skills/xlsx.md) — скилл · 187223 установки
- [google-agents-cli-observability](https://affpapa.org/nevibecode/skills/google-agents-cli-observability.md) — скилл · 511300 установок
- [caveman-evidence-review](https://affpapa.org/nevibecode/skills/caveman-evidence-review.md) — скилл · 104500 установок
- [migration](https://affpapa.org/nevibecode/skills/migration.md) — скилл · 103900 установок
- [performance-optimization](https://affpapa.org/nevibecode/skills/performance-optimization.md) — скилл · 65200 установок
- [supabase](https://affpapa.org/nevibecode/skills/supabase.md) — скилл · 8 установок

Из того же набора: [aj-geddes/useful-ai-prompts](https://affpapa.org/nevibecode/by/aj-geddes/useful-ai-prompts.md) — 118 карточек

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

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