# go-documentation

Скилл настраивает оформление комментариев godoc, тестовых примеров и файлов документации для Go-проектов. Помогает агенту следовать соглашениям Go 1.19+ без лишнего шума в коде.

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

## Что делает

Скилл задаёт агенту строгие правила документирования кода на Go. Публичные идентификаторы получают комментарии, которые начинаются с имени функции или типа и объясняют поведение, обработку ошибок, работу с нулевыми значениями и потокобезопасность. Документация пакета выносится в отдельный файл `doc.go`, если описание не помещается в пару предложений. Для перекрёстных ссылок агент применяет синтаксис Go 1.19 вида `[Type.Method]`.

В инструкции входят правила создания проверяемых примеров в `example_test.go` со специальным блоком `// Output:`. Благодаря этому `go test` автоматически проверяет вывод кода из документации при запуске тестов. Для устаревших функций скилл требует явный префикс `Deprecated:` с обязательной ссылкой на замену. Также агент проверяет оформление README, CHANGELOG и файла `llms.txt`.

Для проверки разметки агенту необходим установленный Go toolchain с утилитами `gofmt` и `go vet`. Если в репозитории заданы собственные правила агента, они имеют приоритет над этим скиллом.

## Установка

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

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

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install eduardo-sl/go-agent-skills go-documentation
```

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

### Gemini CLI

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

2. **Командой платформы**
```bash
gemini skills install https://github.com/eduardo-sl/go-agent-skills --path 'skills/(code-quality)/go-documentation'
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add eduardo-sl/go-agent-skills --skill go-documentation -a opencode
```

### Claude.ai

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

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

## Когда брать
- оформить комментарии godoc для публичного API пакета
- написать проверяемые примеры в `example_test.go` с директивой `// Output:`
- разметить устаревшие функции через префикс `Deprecated:` с указанием альтернативы
- составить README библиотеки или сервиса и обновить CHANGELOG
- сформировать файл `llms.txt` со ссылками на ключевую документацию

## Примеры запросов агенту
- Добавь godoc-комментарии ко всем экспортируемым типам и методам в пакете retry
- Напиши проверяемый пример Example для функции ParseDuration
- Пометь метод Fetch как устаревший и предложи использовать FetchContext

## Похожие
- [grill-with-docs](https://affpapa.org/nevibecode/skills/grill-with-docs.md) — скилл · 1219756 установок
- [skill-creator](https://affpapa.org/nevibecode/skills/skill-creator.md) — скилл · 414180 установок
- [setup-matt-pocock-skills](https://affpapa.org/nevibecode/skills/setup-matt-pocock-skills.md) — скилл · 1052851 установка
- [handoff](https://affpapa.org/nevibecode/skills/handoff.md) — скилл · 1038491 установка
- [triage](https://affpapa.org/nevibecode/skills/triage.md) — скилл · 990453 установки
- [domain-modeling](https://affpapa.org/nevibecode/skills/domain-modeling.md) — скилл · 876391 установка

## Другие версии с тем же именем
- [go-documentation · cxuu](https://affpapa.org/nevibecode/skills/go-documentation.md) — 1300 установок

Из того же набора: [eduardo-sl/go-agent-skills](https://affpapa.org/nevibecode/by/eduardo-sl/go-agent-skills.md) — 34 карточки

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

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