# swift-documenter

Субагент swift-documenter генерирует и обновляет файлы README и документирующие комментарии в коде на Swift. Пригодится после завершения фичи или при пересмотре документации пакета.

- субагент · `type=agent` · Claude Code, Codex, Cursor · ★ 233 у репозитория
- Автор: John Rogers (@johnrogers)
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/johnrogers/claude-swift-engineering/tree/HEAD/plugins/swift-engineering/agents/swift-documenter.md
- Обновлён: 2026-01-18
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/agents/swift-documenter

## Что делает

Агент рассчитан на модель `haiku` и запускается для составления `README.md` всего проекта, описаний отдельных пакетов или строчных комментариев к Swift-коду. В работе он задействует инструменты чтения и правки файлов, поиск через `grep` и выполнение команд в `bash`.

Документирование ведётся по принципу избирательности: очевидный код остаётся без пояснений. Комментарии формата `///` добавляются к публичным API, крупным функциям, сложным алгоритмам и нетипичным обходным путям, причём с фокусом на причины решений, а не пересказ логики.

Субагент ориентирован на Swift 6.2+ со строгой конкурентностью (strict concurrency) и iOS 26.0+, поэтому проверку устаревших методов он связывает с актуальной системной датой.

## Установка

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

1. **Через маркетплейс плагинов**
В чате агента (не в терминале):
```text
/plugin marketplace add johnrogers/claude-swift-engineering
```
В чате агента (не в терминале):
```text
/plugin install swift-engineering@claude-swift-engineering
```

2. **Вручную: положить файлы**
- Файл: `.claude/agents/swift-documenter.md` — Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

### Codex

**Вручную: положить файлы**
- Файл: `.codex/agents/swift-documenter.toml` — Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/agents/swift-documenter.md` — Cursor понимает и .claude/agents/

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/johnrogers/claude-swift-engineering/tree/HEAD/plugins/swift-engineering/agents/swift-documenter.md

## Когда брать
- описать публичные интерфейсы и параметры функций через `///`
- составить `README.md` для нового Swift-пакета
- обновить документацию проекта после реализации фичи
- снабдить комментариями сложные алгоритмы с объяснением причин

## Примеры запросов агенту
- Обнови документацию проекта в `README.md` после добавления новой фичи
- Добавь doc-комментарии к публичным методам в `Sources/NetworkManager.swift`
- Сформируй `README.md` для Swift-пакета в папке `Packages/Core`

## Похожие
- [clerk-swift](https://affpapa.org/nevibecode/skills/clerk-swift.md) — скилл · 15200 установок
- [swift-testing-pro](https://affpapa.org/nevibecode/skills/swift-testing-pro.md) — скилл · 10900 установок
- [swift-expert](https://affpapa.org/nevibecode/agents/swift-expert.md) — субагент · 378 установок
- [swift-testing-expert](https://affpapa.org/nevibecode/skills/swift-testing-expert.md) — скилл · 5700 установок
- [swift-testing](https://affpapa.org/nevibecode/skills/swift-testing.md) — скилл · 4700 установок
- [swift-concurrency](https://affpapa.org/nevibecode/skills/dpearson2699-swift-concurrency.md) — скилл · 4600 установок

Из того же набора: [johnrogers/claude-swift-engineering](https://affpapa.org/nevibecode/by/johnrogers/claude-swift-engineering.md) — 33 карточки

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

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