# documentation

Правило documentation для Claude Code задаёт единый стандарт описания компонентов интерфейса. Ассистент оформляет справку со свойствами, примерами и требованиями доступности.

- правило · `type=rule` · Claude Code, Codex, Cursor, GitHub Copilot, Windsurf (Devin Desktop), Cline · ★ 141 у репозитория
- Автор: maxtrigify
- Лицензия: Apache-2.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/maxtrigify/Otto/tree/HEAD/.agents/skills/components-build/rules/documentation.md
- Обновлён: 2026-11-17
- Проверка безопасности: автоматическая, 2026-11-17 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/rules/documentation

## Что делает

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

Для каждого компонента ИИ формирует полную таблицу свойств с типами TypeScript, значениями по умолчанию и описанием аргументов. В блок доступности включаются проверка клавиатурной навигации, ARIA-атрибуты, видимость фокуса и контрастность по WCAG AA.

Примеры использования должны быть рабочими и контекстными, а не изолированными заглушками. Дополнительно правило требует указывать частые проблемы при интеграции и ссылки на связанные модули интерфейса.

## Установка

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

**Вручную: положить файлы**
- Файл: `.claude/rules/documentation.md` — Поле paths во frontmatter ограничивает файлы

### Codex

**AGENTS.md**
- Codex читает AGENTS.md: вставьте текст правила туда

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/rules/documentation.mdc` — Во frontmatter: description, globs, alwaysApply

### GitHub Copilot

**Вручную: положить файлы**
- Файл: `.github/instructions/documentation.instructions.md` — Поле applyTo задаёт, к каким файлам применять

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/rules/documentation.md`

### Cline

**Вручную: положить файлы**
- Файл: `.clinerules/documentation.md`

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/maxtrigify/Otto/tree/HEAD/.agents/skills/components-build/rules/documentation.md

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

## Примеры запросов агенту
- Напиши документацию для компонента Modal по принятому стандарту
- Добавь таблицу props и блок доступности в документацию к Select
- Создай файл README для новой дизайн-системы с разделом установки и демо

## Похожие
- [design-system](https://affpapa.org/nevibecode/skills/anthropics-design-system.md) — скилл · 4700 установок
- [documentation-template](https://affpapa.org/nevibecode/skills/documentation-template.md) — скилл · 2500 установок
- [component-spec](https://affpapa.org/nevibecode/skills/component-spec.md) — скилл · 2500 установок
- [typescript-documentation-expert](https://affpapa.org/nevibecode/agents/typescript-documentation-expert.md) — субагент · ★ 372 у репозитория
- [documentation-lookup](https://affpapa.org/nevibecode/skills/documentation-lookup.md) — скилл · 6400 установок
- [figma-generate-library](https://affpapa.org/nevibecode/skills/nexu-io-figma-generate-library.md) — скилл · 2900 установок

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

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

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