# elixir-writing-docs

Скилл elixir-writing-docs для Claude Code оформляет документацию Elixir в файлах .ex: аннотации ExDoc, doctests и метаданные.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 106 установок · ★ 89 у репозитория
- Автор: existential-birds
- Лицензия: Apache-2.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/existential-birds/beagle/tree/HEAD/plugins/beagle-elixir/skills/elixir-writing-docs/SKILL.md
- Обновлён: 2026-09-15
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/elixir-writing-docs

## Что делает

Скилл учит ассистента писать документацию в файлах `.ex` по стандартам ExDoc. Он заставляет выносить суть функции или модуля в самое первое предложение, потому что `mix docs` берёт первый абзац как краткое резюме для списков.

Внутри зафиксирована структура секций: заголовки второго уровня `## Examples` и `## Options`, порядок размещения спецификаций `@spec` строго между `@doc` и объявлением функции `def`, а также оформление колбэков для поведений. Приватный код, реализации протоколов и вспомогательные функции помечаются через `@moduledoc false` или `@doc false`, чтобы не засорять публичный API.

Если функция выполняет побочные эффекты, скилл требует отказаться от doctest и оставить обычный пример кода.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill elixir-writing-docs -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill elixir-writing-docs -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill elixir-writing-docs -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install existential-birds/beagle plugins/beagle-elixir/skills/elixir-writing-docs
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill elixir-writing-docs -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/existential-birds/beagle --path plugins/beagle-elixir/skills/elixir-writing-docs
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill elixir-writing-docs -a opencode
```

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/existential-birds/beagle/tree/HEAD/plugins/beagle-elixir/skills/elixir-writing-docs/SKILL.md

## Когда брать
- сформулировать однострочные резюме для @moduledoc и @doc под генератор mix docs
- разметить опции аргументов через секцию ## Options и типы параметров
- скрыть внутренние функции и реализации протоколов с помощью @doc false
- добавить doctests для чистых функций с проверкой через iex>

## Примеры запросов агенту
- Добавь модуль документации @moduledoc и примеры doctest в модуль MyApp.PaymentGateway
- Оформи @doc и @spec для функции с ключевым списком параметров и секцией ## Options
- Разметь депрекацию для старой функции с помощью @doc deprecated: "..."

## Похожие
- [elixir](https://affpapa.org/nevibecode/skills/elixir.md) — скилл · 881 установка
- [elixir-expert](https://affpapa.org/nevibecode/skills/elixir-expert.md) — скилл · 194 установки
- [elixir-ecto-patterns](https://affpapa.org/nevibecode/skills/elixir-ecto-patterns.md) — скилл · 121 установка
- [elixir-otp-patterns](https://affpapa.org/nevibecode/skills/elixir-otp-patterns.md) — скилл · 106 установок
- [elixir-engineer-guidelines-cursorrules-prompt-file](https://affpapa.org/nevibecode/rules/elixir-engineer-guidelines-cursorrules-prompt-file.md) — правило · ★ 41178 у репозитория
- [elixir-pro](https://affpapa.org/nevibecode/agents/elixir-pro.md) — субагент · ★ 42780 у репозитория

Из того же набора: [existential-birds/beagle](https://affpapa.org/nevibecode/by/existential-birds/beagle.md) — 68 карточек

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

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