# code-documentation

Скилл задаёт структуру README, API-справки, комментариев и архитектурных заметок, чтобы агент писал документацию по одному шаблону.

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

## Что делает

Скилл описывает, как оформлять документацию в проекте: шаблон README с разделами Quick Start, Installation, Usage, API Reference, Configuration, Contributing и License, стиль JSDoc/TSDoc для функций и интерфейсов, схему OpenAPI 3.0.0 для HTTP-эндпоинтов. Внутри есть правила, когда комментарий в коде уместен, а когда нет: объяснять причину решения, а не пересказывать строку, и удалять устаревшие комментарии, потому что они хуже отсутствия.

Отдельный блок — архитектурные заметки. ADR пишется по разделам Status, Context, Decision, Rationale, Consequences, а описание модуля включает обзор, поток выполнения, зависимости и переменные конфигурации. Пример с JWT разбирает вход по `/auth/login`, срок жизни access- и refresh-токенов и хранение refresh-токенов в Redis.

Скилл ставится в Claude, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode. Для Copilot команда другая — `gh skill install`, у остальных `npx skills add`. Если в проекте уже есть свой формат README, шаблон скилла с ним поспорит: агент начнёт переписывать разделы под себя, так что перед запуском стоит решить, какой структуры вы держитесь.

## Установка

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

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

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add MoizIbnYousaf/ai-agent-skills --skill code-documentation -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add MoizIbnYousaf/ai-agent-skills --skill code-documentation -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install MoizIbnYousaf/ai-agent-skills code-documentation
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add MoizIbnYousaf/ai-agent-skills --skill code-documentation -a opencode
```

### Claude.ai

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

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

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

## Примеры запросов агенту
- напиши README для этого проекта по шаблону скилла
- задокументируй модуль аутентификации: поток, зависимости и конфигурацию
- проверь комментарии в `src/auth.ts` и убери те, что повторяют код

## Похожие
- [update-docs](https://affpapa.org/nevibecode/skills/update-docs.md) — скилл · 1300 установок
- [api-docs](https://affpapa.org/nevibecode/skills/api-docs.md) — скилл · 891 установка
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10300 установок
- [technical-documentation](https://affpapa.org/nevibecode/skills/technical-documentation.md) — скилл · 1400 установок
- [markdown-documentation](https://affpapa.org/nevibecode/skills/markdown-documentation.md) — скилл · 1300 установок
- [documentation-engineer](https://affpapa.org/nevibecode/skills/documentation-engineer.md) — скилл · 711 установок

## Другие версии с тем же именем
- [code-documentation · bytedance](https://affpapa.org/nevibecode/skills/code-documentation.md) — 1900 установок
- [code-documentation · aj-geddes](https://affpapa.org/nevibecode/skills/aj-geddes-code-documentation.md) — 492 установки

Из того же набора: [moizibnyousaf/ai-agent-skills](https://affpapa.org/nevibecode/by/moizibnyousaf/ai-agent-skills.md) — 6 карточек

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

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