documentation — правило для Claude Code: что делает и как установить
Правило documentation для Claude Code задаёт единый стандарт описания компонентов интерфейса. Ассистент оформляет справку со свойствами, примерами и требованиями доступности.
Apache-2.0 ★ 141 обновлён 2026-11-17
.claude/rules/documentation.mdЧто делает documentation
Правило регламентирует структуру технической документации для библиотек компонентов. В гайд входят восемь обязательных разделов: краткое описание, интерактивное демо, команды установки пакета, список ключевых возможностей, варианты применения, таблица API со свойствами, раздел доступности и журнал изменений.
Для каждого компонента ИИ формирует полную таблицу свойств с типами TypeScript, значениями по умолчанию и описанием аргументов. В блок доступности включаются проверка клавиатурной навигации, ARIA-атрибуты, видимость фокуса и контрастность по WCAG AA.
Примеры использования должны быть рабочими и контекстными, а не изолированными заглушками. Дополнительно правило требует указывать частые проблемы при интеграции и ссылки на связанные модули интерфейса.
Какие задачи решает
- составить полное описание UI-компонента по единому шаблону
- задокументировать свойства TypeScript и события в виде таблицы
- описать требования доступности и сочетания клавиш по WCAG
- добавить секцию частых ошибок при подключении компонента
Примеры запросов агенту
- Напиши документацию для компонента Modal по принятому стандарту
- Добавь таблицу props и блок доступности в документацию к Select
- Создай файл README для новой дизайн-системы с разделом установки и демо
Как установить documentation
Вручную: положить файлы
.claude/rules/documentation.mdПоле paths во frontmatter ограничивает файлы
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.cursor/rules/documentation.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.github/instructions/documentation.instructions.mdПоле applyTo задаёт, к каким файлам применять
Вручную: положить файлы
.devin/rules/documentation.mdВручную: положить файлы
.clinerules/documentation.mdПо шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать
Вопросы о documentation
Как установить documentation в Claude Code?
Сохраните текст правила в файл .claude/rules/documentation.md в корне вашего проекта.
Какие разделы включает шаблон документации?
Шаблон требует обзор компонента, живой пример, команды установки, список возможностей, варианты состояний, таблицу параметров, требования доступности и список изменений.
Что требует правило для блока доступности?
В разделе доступности перечисляются поддержка клавиатуры, ARIA-роли, видимые индикаторы фокуса и контрастность не ниже WCAG AA.
Исходный текст
documentation.md · Apache-2.0
---
title: Component Documentation
impact: MEDIUM
impactDescription: Adoption and developer experience
tags: documentation, jsdoc, examples, api-reference, accessibility-docs
---
## Component Documentation Guide
Create documentation that makes components accessible and easy to use.
### Essential Sections
#### 1. Overview
Brief introduction explaining what the component does:
```markdown
# Button
A versatile button component with multiple variants and sizes. Use for primary actions, secondary actions, or destructive operations.
```
#### 2. Demo and Source Code
Include live demos with code:
```tsx
import { Button } from "@/components/ui/button";
export function ButtonDemo() {
return (
<div className="flex gap-2">
<Button variant="default">Default</Button>
<Button variant="destructive">Destructive</Button>
<Button variant="outline">Outline</Button>
</div>
);
}
```
#### 3. Installation
Clear, copy-paste ready instructions:
```bash
# shadcn/ui CLI
npx shadcn@latest add button
# npm
npm install @acme/ui-components
```
#### 4. Features
List key capabilities:
```markdown
## Features
- **Customizable** – Adjust styles, sizes, and behavior
- **Accessible** – Keyboard navigation, ARIA, screen reader support
- **Composable** – Works with other components
- **Type-safe** – Comprehensive TypeScript types
- **Theming** – Integrates with design tokens
```
#### 5. Examples
Show variants, states, and advanced usage:
```tsx
// Variants
<Button variant="default">Default</Button>
<Button variant="secondary">Secondary</Button>
<Button variant="destructive">Destructive</Button>
// States
<Button disabled>Disabled</Button>
<Button isLoading>Loading...</Button>
// With icon
<Button><Icon /> Save</Button>
```
#### 6. Props/API Reference
Document all props:
```markdown
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `variant` | `"default" \| "secondary" \| "destructive"` | `"default"` | Visual style |
| `size` | `"sm" \| "md" \| "lg"` | `"md"` | Size |
| `disabled` | `boolean` | `false` | Disabled state |
| `onClick` | `(event: MouseEvent) => void` | - | Click handler |
```
#### 7. Accessibility
Document a11y features:
```markdown
## Accessibility
- **Keyboard** - Enter/Space activation
- **ARIA** - Proper roles and attributes
- **Focus** - Visible `:focus-visible` indicators
- **Contrast** - WCAG AA (4.5:1)
```
#### 8. Changelog
Track versions:
```markdown
## Changelog
### v2.0.0
**Breaking:** `variant` uses `"default"` instead of `"primary"`
### v1.2.0
- Added `isLoading` prop
- Added `icon` prop
```
### Best Practices
**Use Real-World Examples:**
```tsx
// ✅ Real-world
function UserProfile({ user }) {
return (
<Card>
<CardHeader>
<CardTitle>{user.name}</CardTitle>
</CardHeader>
<CardContent>
<Button onClick={() => editUser(user.id)}>Edit Profile</Button>
</CardContent>
</Card>
);
}
// ❌ Too abstract
<Button onClick={handleClick}>Button</Button>;
```
**Include Troubleshooting:**
```markdown
## Troubleshooting
**Button not responding:**
- Ensure `onClick` handler is provided
- Check if `disabled` is set
- Verify no parent is capturing events
```
**Link Related Components:**
```markdown
## Related
- [`IconButton`](/components/icon-button)
- [`ButtonGroup`](/components/button-group)
```
**Make Examples Runnable:**
```tsx
// ✅ Complete, runnable
import { Button } from "@/components/ui/button";
import { useState } from "react";
export function CounterButton() {
const [count, setCount] = useState(0);
return <Button onClick={() => setCount(count + 1)}>Count: {count}</Button>;
}
```
### Documentation Checklist
- [ ] Clear overview
- [ ] Live demo
- [ ] Installation instructions
- [ ] Feature list
- [ ] Multiple examples
- [ ] Complete API reference
- [ ] Accessibility docs
- [ ] Changelog
- [ ] Troubleshooting
- [ ] Related components
- [ ] All examples runnable
© maxtrigify · Apache-2.0 · maxtrigify/Otto