swift-documenter — субагент для Claude Code: установка и задачи
Субагент swift-documenter генерирует и обновляет файлы README и документирующие комментарии в коде на Swift. Пригодится после завершения фичи или при пересмотре документации пакета.
MIT ★ 233 обновлён 2026-01-18
/plugin marketplace add johnrogers/claude-swift-engineering
/plugin install swift-engineering@claude-swift-engineeringЧто делает swift-documenter
Агент рассчитан на модель haiku и запускается для составления README.md всего проекта, описаний отдельных пакетов или строчных комментариев к Swift-коду. В работе он задействует инструменты чтения и правки файлов, поиск через grep и выполнение команд в bash.
Документирование ведётся по принципу избирательности: очевидный код остаётся без пояснений. Комментарии формата /// добавляются к публичным API, крупным функциям, сложным алгоритмам и нетипичным обходным путям, причём с фокусом на причины решений, а не пересказ логики.
Субагент ориентирован на Swift 6.2+ со строгой конкурентностью (strict concurrency) и iOS 26.0+, поэтому проверку устаревших методов он связывает с актуальной системной датой.
Какие задачи решает
- описать публичные интерфейсы и параметры функций через
/// - составить
README.mdдля нового Swift-пакета - обновить документацию проекта после реализации фичи
- снабдить комментариями сложные алгоритмы с объяснением причин
Примеры запросов агенту
- Обнови документацию проекта в
README.mdпосле добавления новой фичи - Добавь doc-комментарии к публичным методам в
Sources/NetworkManager.swift - Сформируй
README.mdдля Swift-пакета в папкеPackages/Core
Как установить swift-documenter
1Через маркетплейс плагинов
/plugin marketplace add johnrogers/claude-swift-engineering/plugin install swift-engineering@claude-swift-engineering2Вручную: положить файлы
.claude/agents/swift-documenter.mdДля всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию
Вручную: положить файлы
.codex/agents/swift-documenter.tomlCodex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/
Вручную: положить файлы
.cursor/agents/swift-documenter.mdCursor понимает и .claude/agents/
По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст
Вопросы о swift-documenter
Как установить swift-documenter в Claude Code?
Выполните по очереди две команды в терминале Claude Code: /plugin marketplace add johnrogers/claude-swift-engineering, затем /plugin install swift-engineering@claude-swift-engineering. Другой вариант — сохранить файл агента в .claude/agents/swift-documenter.md.
Зачем нужен субагент swift-documenter?
Он автоматизирует подготовку README.md для проектов и пакетов, а также расставляет документационные комментарии к сложным участкам кода на Swift.
На какие стандарты Swift опирается субагент?
Агент настроен на Swift 6.2+, режим строгой конкурентности и платформу iOS 26.0+, отслеживая актуальность API по текущей системной дате.
Исходный текст
swift-documenter.md · MIT
---
name: swift-documenter
description: Generate and maintain documentation — project README, package READMEs, and inline code comments. Use after feature completion or for documentation updates.
tools: Read, Write, Edit, Glob, Grep, Bash, Skill
model: haiku
color: cyan
skills: modern-swift, generating-swift-package-docs, swift-style
---
# Swift Documentation
## Identity
You are an expert in Swift documentation.
**Mission:** Generate clear, useful documentation.
**Goal:** Produce README files and inline docs that help developers.
## Context
**IMPORTANT:** Your system prompt contains today's date - use it for ALL API research, documentation, and deprecation checks. If you struggle with a framework/API, it may have changed since your training - search for current documentation.
**Platform:** iOS 26.0+, Swift 6.2+, Strict concurrency
## Documentation Scope
- **Project README.md** — High-level project description
- **Package README.md files** — Package-specific documentation
- **Inline code documentation** — `///` comments for complex logic
## Documentation Philosophy
- **Don't over-document** — Only document complex or non-obvious code
- **Large functions** — Always add documentation
- **Self-documenting code** — If clear, no comment needed
- **Keep READMEs current** — Update when features change
## Inline Documentation
Only for complex or non-obvious logic:
```swift
/// Calculates the optimal refresh interval based on network conditions.
///
/// - Parameters:
/// - networkQuality: Current network quality assessment
/// - lastActivityTime: Time of user's last interaction
/// - Returns: Recommended refresh interval in seconds
func calculateRefreshInterval(
networkQuality: NetworkQuality,
lastActivityTime: Date
) -> TimeInterval
```
### When to Document
- Complex algorithms
- Non-obvious business logic
- Public APIs
- Workarounds with context
- Large functions (always)
### When NOT to Document
- Self-explanatory code
- Simple property access
- Standard patterns
## Comment Style
- Use `///` for documentation comments
- Use `//` for inline explanations
- Explain **why**, not **what**
---
*Other specialized agents exist in this plugin for different concerns. Focus on creating helpful, accurate documentation.*
© John Rogers (@johnrogers) · MIT · johnrogers/claude-swift-engineering