# writing-user-docs

Скилл writing-user-docs для Claude Code задаёт тон и структуру пользовательской документации. Помогает писать и править тексты для тех, кто работает с инструментом.

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

## Что делает

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

Внутри — правила голоса и структуры. Тон обыденный, как при объяснении коллеге за соседним столом: второе лицо, активный залог, настоящее время. Убрать «просто», «легко», «очевидно» и маркетинговые эпитеты. Один термин на одно понятие, совпадающий с интерфейсом: если кнопка называется Workspace, в тексте не будет «проект» или «рабочее пространство».

Скилл требует писать о целях пользователя, а не о функциях: заголовок «Поделиться отчётом с человеком вне команды», а не «Модуль шаринга». Ограничения и требования идут в начало, путь к решению — один, альтернативы коротко в конце. Отдельный акцент — на неудачные сценарии: ошибки, чего фича не делает, предупреждения перед опасными действиями.

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

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add callstackincubator/agent-skills --skill writing-user-docs -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add callstackincubator/agent-skills --skill writing-user-docs -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add callstackincubator/agent-skills --skill writing-user-docs -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install callstackincubator/agent-skills skills/writing-user-docs
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add callstackincubator/agent-skills --skill writing-user-docs -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/callstackincubator/agent-skills --path skills/writing-user-docs
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add callstackincubator/agent-skills --skill writing-user-docs -a opencode
```

### Claude.ai

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

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

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

## Примеры запросов агенту
- Напиши документацию для этой фичи по стилю `writing-user-docs`.
- Перепиши этот README: оставь только то, что нужно пользователю библиотеки.
- Проверь эту справку на тон, воду и утечки деталей реализации.

## Похожие
- [llm-writing](https://affpapa.org/nevibecode/skills/haowjy-llm-writing.md) — скилл · 815 установок
- [writing-clearly-and-concisely](https://affpapa.org/nevibecode/skills/writing-clearly-and-concisely.md) — скилл · 206 установок
- [writing-simplified-technical-english](https://affpapa.org/nevibecode/skills/writing-simplified-technical-english.md) — скилл · 138 установок
- [writing-guidelines](https://affpapa.org/nevibecode/skills/writing-guidelines.md) — скилл · 133400 установок
- [pragmatic-writing](https://affpapa.org/nevibecode/skills/pragmatic-writing.md) — скилл · ★ 139 у репозитория
- [elixir-writing-docs](https://affpapa.org/nevibecode/skills/elixir-writing-docs.md) — скилл · 106 установок

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

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