# technical-writing

Скилл technical-writing задаёт правила технического текста: вести с пользы, подтверждать примерами и числами, резать лишние слова. Включается при написании постов, документации и туториалов.

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

## Что делает

Скилл даёт структуру для блог-постов (хук, контекст, обещание — тело из 3-5 секций с одной идеей каждая — вывод с конкретным действием) и чек-лист перед публикацией: заголовок обещает конкретику, заявления подтверждены примерами, каждое число привязано к источнику. Отдельно разбирает, как писать для разработчиков, QA-инженеров и руководства — у каждой аудитории свой вход в текст и свой набор деталей.

Главное требование — никогда не выдумывать цифры: если число неизвестно, скилл велит ставить плейсхолдер `[number?]` и спрашивать, а не вставлять правдоподобное значение. Есть таблица слов на вылет (basically, leverage, very) и примеры трансформации канцелярских формулировок в конкретные. В комплект входят примеры интеграции с агентами `qe-quality-analyzer` и `qe-api-contract-validator` для генерации и проверки документации по коду — это часть набора agentic-qe, без него примеры с `Task()` и `FleetManager` не выполнятся.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add proffesor-for-testing/agentic-qe --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 proffesor-for-testing/agentic-qe --skill technical-writing -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add proffesor-for-testing/agentic-qe --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 proffesor-for-testing/agentic-qe assets/skills/technical-writing
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add proffesor-for-testing/agentic-qe --skill technical-writing -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/proffesor-for-testing/agentic-qe --path assets/skills/technical-writing
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add proffesor-for-testing/agentic-qe --skill technical-writing -a opencode
```

### Claude.ai

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

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

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

## Примеры запросов агенту
- Перепиши этот абзац README по принципам из скилла technical-writing
- Проверь черновик статьи по чек-листу из technical-writing перед публикацией
- Сгенерируй документацию для PaymentService.ts и проверь её на корпоративный жаргон

## Похожие
- [technical-blog-writing](https://affpapa.org/nevibecode/skills/technical-blog-writing.md) — скилл · 237 установок
- [writing-simplified-technical-english](https://affpapa.org/nevibecode/skills/writing-simplified-technical-english.md) — скилл · 138 установок
- [writing-clearly-and-concisely](https://affpapa.org/nevibecode/plugins/writing-clearly-and-concisely.md) — плагин · ★ 2707 у репозитория
- [technical-tutorials](https://affpapa.org/nevibecode/skills/technical-tutorials.md) — скилл · ★ 88 у репозитория
- [technical-writer](https://affpapa.org/nevibecode/agents/superclaude-org-technical-writer.md) — субагент · ★ 23950 у репозитория
- [written-communication](https://affpapa.org/nevibecode/skills/written-communication.md) — скилл · 2300 установок

## Другие версии с тем же именем
- [technical-writing · backnotprop](https://affpapa.org/nevibecode/skills/backnotprop-technical-writing.md) — 10700 установок
- [technical-writing · riekelt](https://affpapa.org/nevibecode/skills/technical-writing.md) — 27800 установок
- [technical-writing · frappe](https://affpapa.org/nevibecode/skills/frappe-technical-writing.md) — 766 установок

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

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