# technical-documentation

Скилл проверяет и переписывает документацию по гайдлайну Google: README, how-to, справочники API, changelog. Пригодится, когда доки расползлись по тону и структуре.

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

## Что делает

Скилл ведёт работу от задачи читателя, а не от списка фич продукта. Сначала он выясняет, кто читатель и что он должен уметь после прочтения, потом подбирает тип документа: туториал, how-to, концепция, справочник, README. Дальше правки идут по порядку важности — структура, затем голос, и только потом слова.

Внутри — правила Google Developer Documentation Style Guide и курса Technical Writing. Проверяются обращение на «вы», активный залог, настоящее время, порядок «условие перед действием», заголовки, списки и таблицы, примеры кода с плейсхолдерами, текст ссылок, примечания и доступность. Часть правил помечена `[EN]` — орфография, серийная запятая, сокращения, словарь — и к неанглийским текстам не применяется. Документ без запроса не переводят.

Оценка ставится по десяти строкам быстрой диагностики, по баллу за строку. Баллы 9–10 означают, что можно выпускать; 5–6 — сначала перестроить разделы. Отдельно есть блокирующий фильтр: неверные или непроверяемые факты, процедура, которую нельзя выполнить до конца, и информация, живущая только в картинке без alt-текста, останавливают публикацию при любом балле. Учтите: скилл опирается на гайдлайн Google, поэтому в проекте со своим стайлгайдом первым идёт он, а Google — уже после.

## Установка

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

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

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install wondelai/skills technical-documentation
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

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

### Claude.ai

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

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

## Когда брать
- проверить README перед публикацией релиза
- переписать how-to так, чтобы шаги выполнялись по порядку
- развести концепцию и процедуру по разным страницам
- свести к одному голосу и терминам набор разрозненных доков
- написать справочник API и docstrings из кода

## Примеры запросов агенту
- проверь наш README по гайдлайну Google и покажи, что не проходит
- перепиши эту инструкцию: убери пассив и вынеси условия перед шагами
- сделай getting started для нового CLI

## Похожие
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10300 установок
- [technical-writer](https://affpapa.org/nevibecode/skills/technical-writer.md) — скилл · 1000 установок
- [technical-writing](https://affpapa.org/nevibecode/skills/backnotprop-technical-writing.md) — скилл · 5500 установок
- [reviewing-technical-prose](https://affpapa.org/nevibecode/skills/reviewing-technical-prose.md) — скилл · 18200 установок
- [code-documentation](https://affpapa.org/nevibecode/skills/code-documentation.md) — скилл · 1900 установок
- [markdown-documentation](https://affpapa.org/nevibecode/skills/markdown-documentation.md) — скилл · 1300 установок

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

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

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