К основному содержанию
субагент CX Codex

swift-documenter — субагент для Claude Code: установка и задачи

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

MIT ★ 233 обновлён 2026-01-18

Установить в Claude Code · Через маркетплейс плагинов Все способы и платформы ↓
/plugin marketplace add johnrogers/claude-swift-engineering
/plugin install swift-engineering@claude-swift-engineering
Открыть на GitHub

Что делает 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-engineering

2Вручную: положить файлы

.claude/agents/swift-documenter.md

Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

По шагам, с командами для каждой платформы: Субагенты 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

Похожие субагенты

Все субагенты по теме «Тексты и документация» →
clerk-swift clerk Скилл clerk-swift для Claude Code настраивает UI аутентификации Clerk в нативных приложениях Swift на iOS и macOS. Помогает внедрить готовые экраны ClerkKitUI или собрать собственный флоу через ClerkKit. CX Codex +1 15 200установок swift-testing-pro Paul Hudson Скилл swift-testing-pro для Claude Code, Codex, Cursor и других агентов: пишет, проверяет и правит тесты на Swift Testing по актуальным API Swift 6.2. Покрывает async-тесты, миграцию с XCTest и новые фичи фреймворка. CX Codex +1 10 900установок swift-expert VoltAgent Community Субагент swift-expert помогает разрабатывать Swift-приложения для iOS, macOS и серверного Swift. Подходит для SwiftUI, async/await, акторов и проверки управления памятью. CX Codex 378установок swift-testing-expert AvdLee Скилл swift-testing-expert помогает писать и разбирать тесты на Swift Testing: макросы #expect и #require, теги, параметризация, миграция с XCTest. CX Codex +1 5 700установок swift-testing dpearson2699 Пишет тесты на Swift Testing и переводит на них существующие проверки XCTest, подсказывая, что оставить в XCTest и XCUITest. CX Codex +1 4 700установок swift-concurrency dpearson2699 Скилл swift-concurrency помогает устранять ошибки Sendable и изоляции акторов в Swift 6.2+, настраивать фоновые задачи и применять SE-0466. CX Codex +1 4 600установок

Из того же набора33

Весь набор →
snapshot Команда создаёт краткую выписку о проделанной работе и сохраняет её в файл .claude/snapshot.md. Пригодится, чтобы быстро восстановить контекст в следующей сессии через команду resume-snapshot. CX Codex +1 ★ 233звёзд репо generating-swift-package-docs Скилл generating-swift-package-docs генерирует справочную документацию по Swift-пакетам прямо из DerivedData проекта при анализе незнакомых библиотек. CX Codex +1 ★ 233звёзд репо five-whys Правило five-whys проводит разбор первопричины через пять вопросов «почему». Подходит для поиска системной причины сбоя, а не только его симптома. CX Codex +1 ★ 233звёзд репо swift-test-creator Субагент swift-test-creator для Claude Code и Codex пишет юнит- и интеграционные тесты на Swift Testing с @Test, #expect и #require. Создаёт тесты для готовой реализации. CX Codex ★ 233звёзд репо swift-modernizer Субагент swift-modernizer находит устаревшие конструкции Swift и переносит их на async/await, современные API и SwiftUI. Он пригодится при поэтапной модернизации старого кода. CX Codex ★ 233звёзд репо reflect Команда reflect для Claude Code разбирает историю чата и настройки, а затем предлагает правки инструкций, команд и конфигурации. CX Codex +1 ★ 233звёзд репо swift-networking Скилл swift-networking помогает проектировать сетевой слой на базе Network.framework в Swift, настраивать сокеты, переключаться между Wi-Fi и сотовой сетью и разгружать главный поток. CX Codex +1 ★ 233звёзд репо ios-hig Скилл ios-hig помогает проектировать интерфейсы iOS с учётом рекомендаций Apple по доступности, визуальному оформлению и взаимодействию. Пригодится при создании экранов и проверке уже готовых элементов. CX Codex +1 ★ 233звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой