# technical-writing

Задаёт четыре слоя стандартов для технического текста: архитектуру Diátaxis, стиль Google, правила STE и Global English. Нужен при оформлении ридми, RFC и PR.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 5500 установок · ★ 2737
- Автор: backnotprop
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/backnotprop/pstack/tree/HEAD/skills/technical-writing/SKILL.md
- Обновлён: 2026-10-24
- HTML: https://affpapa.org/nevibecode/skills/backnotprop-technical-writing

## Что делает

Скилл выстраивает текст по четырём уровням: архитектура Diátaxis, стиль документации Google, правила Simplified Technical English и нормы Global English. Автор предлагает убирать все слова без полезной нагрузки. Вместо «in order to» остаётся «to», а длинные слова заменяются простыми аналогами из повседневной речи разработчиков. В тексте используются точные имена файлов, флагов и символов из кодовой базы, а не абстрактные описания.

Работа начинается с выбора одного из четырёх режимов Diátaxis: учебник (tutorial), руководство к задаче (how-to), справочник (reference) или концептуальное объяснение (explanation). Скилл запрещает смешивать форматы: попытка вставить справочную таблицу параметров прямо внутрь обучающего руководства сломает структуру. Правила Google и STE требуют писать короткими утверждениями, ставить условие перед действием и обращаться к читателю напрямую. В параметрах скилла включён флаг `disable-model-invocation: true`, поэтому агент не запускает правила автоматически без прямого запроса пользователя.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add backnotprop/pstack --skill technical-writing -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add backnotprop/pstack --skill technical-writing -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add backnotprop/pstack --skill technical-writing -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install backnotprop/pstack technical-writing
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add backnotprop/pstack --skill technical-writing -a gemini-cli
```

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

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add backnotprop/pstack --skill technical-writing -a opencode
```

### Claude.ai

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

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

## Когда брать
- структурировать документацию по методологии Diátaxis
- убрать лишние вводные фразы из описаний pull request
- переписать запутанные шаги инструкции по правилам STE
- подготовить понятное техническое описание для RFC

## Примеры запросов агенту
- /technical-writing перепиши этот README по правилам режима how-to
- Проверь описание pull request через technical-writing и убери лишние слова
- /technical-writing структурируй документацию API по правилам reference

## Похожие
- [writing-documentation-with-diataxis](https://affpapa.org/nevibecode/skills/writing-documentation-with-diataxis.md) — скилл · 615 установок
- [technical-documentation](https://affpapa.org/nevibecode/skills/technical-documentation.md) — скилл · 1400 установок
- [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) — скилл · 10200 установок
- [reviewing-technical-prose](https://affpapa.org/nevibecode/skills/reviewing-technical-prose.md) — скилл · 18200 установок
- [documentation](https://affpapa.org/nevibecode/skills/mcollina-documentation.md) — скилл · 1800 установок

## Другие версии с тем же именем
- [technical-writing · mindrally](https://affpapa.org/nevibecode/skills/mindrally-technical-writing.md) — 1200 установок
- [technical-writing · akillness](https://affpapa.org/nevibecode/skills/akillness-technical-writing.md) — 544 установки

Из того же набора: [backnotprop/pstack](https://affpapa.org/nevibecode/by/backnotprop/pstack.md) — 44 карточки

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

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