# technical-writer

Скилл technical-writer помогает оформлять документацию для разработчиков по методологии Diátaxis: API-справочники, ADR, ранбуки и README с проверенными примерами кода.

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

## Что делает

Скилл структурирует техническую документацию по фреймворку Diátaxis, распределяя материалы по четырём категориям: обучающие туториалы, практические how-to инструкции, концептуальные объяснения и справочники. Подход требует обязательной проверки примеров кода и явного перечисления предварительных требований перед началом инструкций.

В составе идут готовые шаблоны в каталоге `./references/`: заготовки для `README.md`, архитектурных записей решений ADR, спецификаций REST API и эксплуатационных регламентов. Для автоматической проверки документации предусмотрен скрипт `./scripts/validate-docs.sh`, находящий битые ссылки и структурные ошибки. Вызовы терминала ограничены только утилитами документации: `npm run docs:*`, `mkdocs:*` и `docusaurus:*`.

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

## Установка

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

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

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add curiositech/some_claude_skills --skill technical-writer -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add curiositech/some_claude_skills --skill technical-writer -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install curiositech/some_claude_skills .claude/skills/technical-writer
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add curiositech/some_claude_skills --skill technical-writer -a opencode
```

### Claude.ai

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

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

## Когда брать
- составить архитектурную запись решений (ADR) по готовому шаблону
- структурировать руководство по фреймворку Diátaxis без пропуска шагов
- оформить спецификацию REST API с разделом устранения типичных сбоев
- проверить проектную документацию на битые ссылки через `validate-docs.sh`

## Примеры запросов агенту
- Сделай ADR для перехода на PostgreSQL по шаблону из references
- Напиши how-to руководство по деплою сервиса с разделом troubleshooting
- Проверь документацию проекта через скрипт validate-docs.sh

## Похожие
- [technical-writing](https://affpapa.org/nevibecode/skills/rudolf-s-technical-writing.md) — скилл · ★ 587 у репозитория
- [agent-technical-writer](https://affpapa.org/nevibecode/skills/agent-technical-writer.md) — скилл · 108 установок
- [documentation-writer](https://affpapa.org/nevibecode/skills/documentation-writer.md) — скилл · 27757 установок
- [ns-docs-writer](https://affpapa.org/nevibecode/skills/ns-docs-writer.md) — скилл · 151 установка
- [Technical Documentation taste](https://affpapa.org/nevibecode/prompts/technical-documentation-taste.md) — промпт · ★ 178201 у репозитория
- [tech-docs-writer](https://affpapa.org/nevibecode/agents/tech-docs-writer.md) — субагент · ★ 1064 у репозитория

## Другие версии с тем же именем
- [technical-writer · onewave-ai](https://affpapa.org/nevibecode/skills/technical-writer.md) — 1100 установок

Из того же набора: [curiositech/some_claude_skills](https://affpapa.org/nevibecode/by/curiositech/some_claude_skills.md) — 180 карточек

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

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