# how-to-documentation-cursorrules-prompt-file

Правило превращает технические шаги, тест-скрипты и скриншоты в пошаговые инструкции для нетехнических пользователей. Пригодится, когда нужно писать «How To» по фиче.

- правило · `type=rule` · Cursor · ★ 41024
- Автор: PatrickJS
- Лицензия: CC0-1.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/PatrickJS/awesome-cursorrules/tree/HEAD/rules/how-to-documentation-cursorrules-prompt-file.mdc
- Обновлён: 2026-05-30
- HTML: https://affpapa.org/nevibecode/rules/how-to-documentation-cursorrules-prompt-file

## Что делает

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

Отдельный блок объясняет, как переводить технический контент в инструкцию: определить фичу и её аудиторию, вытащить действия пользователя из технических шагов, заменить термины на понятные слова, выстроить шаги по порядку и добавить ожидаемый результат. В примере показано, как тест на вход в приложение превращается в документ с шестью шагами и подсказкой про забытый пароль.

Правило применяется к файлам по маске `**/*`, но `alwaysApply` стоит в `false` — значит, его нужно подключать вручную, иначе оно не сработает. Это повод проверить настройки после установки.

## Установка

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

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

### Claude Code

**Вручную: положить файлы**
- Файл: `.claude/rules/how-to-documentation-cursorrules-prompt-file.md` — Поле paths во frontmatter ограничивает файлы: globs из источника → paths

### Codex

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

### GitHub Copilot

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

### Windsurf (Devin Desktop)

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

### Cline

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/PatrickJS/awesome-cursorrules/tree/HEAD/rules/how-to-documentation-cursorrules-prompt-file.mdc

## Когда брать
- написать инструкцию «How To» по новой фиче
- перевести тест-скрипт в шаги для пользователя
- убрать технический жаргон из черновика документации
- добавить раздел с частыми проблемами и их решениями
- описать ожидаемый результат после каждого действия

## Примеры запросов агенту
- Собери How To по этой фиче из тест-скрипта, простым языком
- Перепиши этот черновик в пошаговую инструкцию с ожидаемым результатом
- Добавь в документ предварительные требования и раздел с частыми проблемами

## Похожие
- [documentation-writer](https://affpapa.org/nevibecode/skills/documentation-writer.md) — скилл · 27757 установок
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10300 установок
- [technical-documentation](https://affpapa.org/nevibecode/skills/technical-documentation.md) — скилл · 1400 установок
- [writing-documentation-with-diataxis](https://affpapa.org/nevibecode/skills/writing-documentation-with-diataxis.md) — скилл · 615 установок
- [code-documentation](https://affpapa.org/nevibecode/plugins/code-documentation.md) — плагин · ★ 41823
- [markdown-documentation](https://affpapa.org/nevibecode/skills/markdown-documentation.md) — скилл · 1300 установок

Из того же набора: [patrickjs/awesome-cursorrules](https://affpapa.org/nevibecode/by/patrickjs/awesome-cursorrules.md) — 234 карточки

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

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