# technical-writing

Скилл technical-writing составляет архитектурные решения (ADR), системную документацию, описания API и эксплуатационные регламенты прямо в репозитории проекта.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 587 у репозитория
- Автор: Rudolf S.
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/rsmdt/the-startup/tree/HEAD/plugins/team/skills/development/technical-writing/SKILL.md
- Обновлён: 2026-10-26
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/rudolf-s-technical-writing

## Что делает

Скилл определяет нужный тип документа по запросу пользователя. Для решений по архитектуре создаётся ADR, для общего описания сервиса — системная документация, для эндпоинтов — спецификация API, а для процедур развёртывания и аварийных сценариев — runbook. Скилл опирается на файлы шаблонов из каталога `templates/`, например `templates/adr-template.md`.

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

## Установка

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

1. **Через маркетплейс плагинов**
В чате агента (не в терминале):
```text
/plugin marketplace add rsmdt/the-startup
```
В чате агента (не в терминале):
```text
/plugin install team@the-startup
```
Команда ставит плагин team целиком, со всеми его скиллами

2. **Через Skills CLI (Vercel)**
```bash
npx skills add rsmdt/the-startup --skill technical-writing -a claude-code
```

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

### Codex

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

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add rsmdt/the-startup --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 rsmdt/the-startup plugins/team/skills/development/technical-writing
```

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

### Gemini CLI

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

2. **Командой платформы**
```bash
gemini skills install https://github.com/rsmdt/the-startup --path plugins/team/skills/development/technical-writing
```

### Windsurf (Devin Desktop)

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

### Claude.ai

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

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

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

## Примеры запросов агенту
- Зафиксируй в ADR, почему мы перешли с REST на gRPC для внутреннего межсервисного взаимодействия
- Напиши runbook для перезапуска воркеров очереди при зависании задач
- Составь системную документацию по сервису биллинга с описанием компонентов и потоков данных

## Похожие
- [technical-writer](https://affpapa.org/nevibecode/skills/curiositech-technical-writer.md) — скилл · 221 установка
- [technical-blog-writing](https://affpapa.org/nevibecode/skills/technical-blog-writing.md) — скилл · 237 установок
- [writing-adrs](https://affpapa.org/nevibecode/skills/writing-adrs.md) — скилл · 1700 установок
- [technical-docs](https://affpapa.org/nevibecode/skills/technical-docs.md) — скилл · 177 установок
- [agent-technical-writer](https://affpapa.org/nevibecode/skills/agent-technical-writer.md) — скилл · 108 установок
- [technical-specification](https://affpapa.org/nevibecode/skills/technical-specification.md) — скилл · 816 установок

## Другие версии с тем же именем
- [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 установок
- [technical-writing · mindrally](https://affpapa.org/nevibecode/skills/mindrally-technical-writing.md) — 1200 установок
- [technical-writing · proffesor-for-testing](https://affpapa.org/nevibecode/skills/proffesor-for-testing-technical-writing.md) — 209 установок

Из того же набора: [rsmdt/the-startup](https://affpapa.org/nevibecode/by/rsmdt/the-startup.md) — 50 карточек

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

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