# diataxis

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

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

## Что делает

Скилл включается, когда вы просите написать README, API-справочник, гайд или онбординг, и даже на бытовое «улучши README». Внутри рамка Diátaxis: любой текст относят к одному из четырёх режимов (туториал, инструкция, справочник, объяснение) и держат в нём одном. Главный инструмент — компас из двух вопросов: про действие или про понимание, для обучения или для работы. Ответ сразу даёт режим.

Внутри есть деревья решений под конкретные симптомы: страница раздулась и смешивает всё сразу, новичок не может начать, пользователь не находит нужный факт. Отдельные гайды по каждому режиму и `workflow.md` задают мелкий шаг: выбрать кусок, оценить, сделать одно действие, опубликовать. Для большого корпуса страниц пригодится `bash references/queries/scan-docs.sh <docs_root>`: скрипт показывает, где намешано больше одного режима.

Для вычитки текста внутри уже верного режима скилл не нужен, там работает копирайтинг. Правки идут мелкими шагами, без переписывания раздела сверху вниз. Качество проверяют по `quality.md`: точность, полнота, последовательность и удобство чтения.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add pproenca/dot-skills --skill diataxis -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add pproenca/dot-skills --skill diataxis -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add pproenca/dot-skills --skill diataxis -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install pproenca/dot-skills skills/.experimental/diataxis
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add pproenca/dot-skills --skill diataxis -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/pproenca/dot-skills --path skills/.experimental/diataxis
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add pproenca/dot-skills --skill diataxis -a opencode
```

### Claude.ai

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

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

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

## Примеры запросов агенту
- Напиши README для библиотеки, но сначала прогони компас и скажи, какой режим тут нужен.
- Документация в `docs/` путаная: запусти `bash references/queries/scan-docs.sh docs` и предложи, с какой страницы начать.
- В `api.md` смешаны вступление и таблица методов. Оставь таблицу справочником, а вступление переделай в объяснение.

## Похожие
- [writing-documentation-with-diataxis](https://affpapa.org/nevibecode/skills/writing-documentation-with-diataxis.md) — скилл · 648 установок
- [diataxis-writer](https://affpapa.org/nevibecode/skills/diataxis-writer.md) — скилл · ★ 117 у репозитория
- [documentation-writer](https://affpapa.org/nevibecode/skills/documentation-writer.md) — скилл · 27757 установок
- [developer-docs-structure-audit](https://affpapa.org/nevibecode/skills/developer-docs-structure-audit.md) — скилл · 13700 установок
- [technical-writing](https://affpapa.org/nevibecode/skills/backnotprop-technical-writing.md) — скилл · 10700 установок
- [documentation](https://affpapa.org/nevibecode/skills/mcollina-documentation.md) — скилл · 2000 установок

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

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