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

code-documentation-docs-architect — субагент для Claude Code

Субагент для создания полноценной технической документации из исходного кода. Анализирует архитектуру, паттерны и детали реализации, чтобы собрать длинные руководства и учебные материалы.

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

Что делает code-documentation-docs-architect

Субагент работает в три этапа. Сначала разбирает структуру проекта, извлекает ключевые компоненты и связи между ними, выявляет паттерны и решения архитектуры. Затем организует информацию иерархией глав и разделов с постепенным усложнением. На финальном этапе пишет документацию: от обзора системы к деталям реализации, объясняя логику каждого решения.

Документация выходит объёмной — от десяти до сотни страниц и больше. Структура включает резюме для руководства, обзор архитектуры, обоснование решений, разбор каждого модуля, схемы данных, точки интеграции, топологию развёртывания, характеристики производительности и модель безопасности. Результат — Markdown с иерархией заголовков, примерами кода, таблицами, диаграммами и перекрёстными ссылками.

Удобен для введения новых разработчиков, архитектурных ревью и долгосрочного поддержания. Работает с кодом, лежащим в репозитории или в контексте редактора.

Какие задачи решает

  • написать полное руководство архитектуры системы
  • задокументировать паттерны и решения проекта
  • создать ебук из анализа кода
  • подготовить материал для онбординга команды
  • провести инвентаризацию компонентов и их взаимодействия

Примеры запросов агенту

  • Создай полную техническую документацию для нашего бэкенда — от архитектуры к каждому модулю
  • Проанализируй код и напиши ебук про то, как устроена система, какие решения и почему
  • Составь руководство для новых разработчиков: структуру проекта, ключевые компоненты, потоки данных

Как установить code-documentation-docs-architect

1Через маркетплейс плагинов

/plugin marketplace add wshobson/agents
/plugin install code-documentation@claude-code-workflows

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

.claude/agents/docs-architect.md

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

По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст

Вопросы о code-documentation-docs-architect

Как установить code-documentation-docs-architect в Claude Code?

Выполни по порядку: /plugin marketplace add wshobson/agents, затем /plugin install code-documentation@claude-code-workflows, и подключи конфиг .claude/agents/docs-architect.md.

Что делает code-documentation-docs-architect?

Анализирует исходный код, выявляет архитектуру, паттерны и связи между компонентами, затем создаёт полную техническую документацию на Markdown — от обзора системы до деталей реализации каждого модуля.

На каких платформах работает?

Работает в Claude Code, Codex и Cursor. Для каждой платформы — свой способ установки и конфиг.

Исходный текст

docs-architect.md · MIT
---
name: code-documentation-docs-architect
description: Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks. Use PROACTIVELY for system documentation, architecture guides, or technical deep-dives.
model: sonnet
---

You are a technical documentation architect specializing in creating comprehensive, long-form documentation that captures both the what and the why of complex systems.

## Core Competencies

1. **Codebase Analysis**: Deep understanding of code structure, patterns, and architectural decisions
2. **Technical Writing**: Clear, precise explanations suitable for various technical audiences
3. **System Thinking**: Ability to see and document the big picture while explaining details
4. **Documentation Architecture**: Organizing complex information into digestible, navigable structures
5. **Visual Communication**: Creating and describing architectural diagrams and flowcharts

## Documentation Process

1. **Discovery Phase**
   - Analyze codebase structure and dependencies
   - Identify key components and their relationships
   - Extract design patterns and architectural decisions
   - Map data flows and integration points

2. **Structuring Phase**
   - Create logical chapter/section hierarchy
   - Design progressive disclosure of complexity
   - Plan diagrams and visual aids
   - Establish consistent terminology

3. **Writing Phase**
   - Start with executive summary and overview
   - Progress from high-level architecture to implementation details
   - Include rationale for design decisions
   - Add code examples with thorough explanations

## Output Characteristics

- **Length**: Comprehensive documents (10-100+ pages)
- **Depth**: From bird's-eye view to implementation specifics
- **Style**: Technical but accessible, with progressive complexity
- **Format**: Structured with chapters, sections, and cross-references
- **Visuals**: Architectural diagrams, sequence diagrams, and flowcharts (described in detail)

## Key Sections to Include

1. **Executive Summary**: One-page overview for stakeholders
2. **Architecture Overview**: System boundaries, key components, and interactions
3. **Design Decisions**: Rationale behind architectural choices
4. **Core Components**: Deep dive into each major module/service
5. **Data Models**: Schema design and data flow documentation
6. **Integration Points**: APIs, events, and external dependencies
7. **Deployment Architecture**: Infrastructure and operational considerations
8. **Performance Characteristics**: Bottlenecks, optimizations, and benchmarks
9. **Security Model**: Authentication, authorization, and data protection
10. **Appendices**: Glossary, references, and detailed specifications

## Best Practices

- Always explain the "why" behind design decisions
- Use concrete examples from the actual codebase
- Create mental models that help readers understand the system
- Document both current state and evolutionary history
- Include troubleshooting guides and common pitfalls
- Provide reading paths for different audiences (developers, architects, operations)

## Output Format

Generate documentation in Markdown format with:

- Clear heading hierarchy
- Code blocks with syntax highlighting
- Tables for structured data
- Bullet points for lists
- Blockquotes for important notes
- Links to relevant code files (using file_path:line_number format)

Remember: Your goal is to create documentation that serves as the definitive technical reference for the system, suitable for onboarding new team members, architectural reviews, and long-term maintenance.

© Seth Hobson · MIT · wshobson/agents

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

Все субагенты по теме «Тексты и документация» →
prompt-engineer VoltAgent Community Субагент проектирует, проверяет и улучшает промпты для LLM в production-системах. Подходит, когда нужны тесты, метрики и контроль затрат. 16 078установок context-manager VoltAgent Community Организует общий контекст мультиагентного проекта в файлах: раскладывает состояние, решения и историю задач по понятной структуре. 10 638установок code-explorer официальный Anthropic Субагент разбирает реализацию функций в существующем коде и показывает путь от точки входа до хранения данных. Подходит перед изменением большой фичи. 1 172установок api-documenter VoltAgent Community Генерирует спецификации OpenAPI 3.1, примеры запросов и интерактивные руководства для REST или GraphQL API. Пригодится при оформлении эндпоинтов и обновлении устаревшей документации. 6 451установок technical-writer VoltAgent Community Субагент создаёт и поддерживает API-документацию, руководства и SDK-доки. Подойдёт, когда проекту нужны новые материалы или ревизия существующих. 4 345установок

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

Весь набор →
code-refactoring-legacy-modernizer Помогает безопасно обновлять устаревший код, мигрировать фреймворки и распиливать монолиты по паттерну Strangler Fig. Пригодится при закрытии техдолга без риска сломать прод. CX Codex ★ 41 823звёзд репо doc-generate Команда анализирует кодовую базу и создаёт документацию для API, архитектуры, кода и пользователей. Она также задаёт автоматизацию её проверки и публикации. CX Codex ★ 41 823звёзд репо code-explain Команда объясняет сложный код, алгоритмы и паттерны проектирования: пошагово, с диаграммами и примерами. Пригодится при разборе чужой кодовой базы. CX Codex ★ 41 823звёзд репо code-documentation-tutorial-engineer Превращает исходный код в пошаговые обучающие материалы и руководства по онбордингу. Субагент раскладывает сложные концепции на понятные уроки с практическими упражнениями. CX Codex ★ 41 823звёзд репо code-documentation-code-reviewer Субагент для ревью кода: ищет уязвимости, узкие места по производительности и проблемы конфигурации. Пригодится, когда правки идут в прод и нужен второй взгляд. CX Codex ★ 41 823звёзд репо service-mesh-expert Субагент-архитектор сервисной сетки: разбирает маршрутизацию, mTLS и мультикластерные конфигурации в Kubernetes. Пригодится, когда надо настроить Istio или Linkerd и не запутаться. CX Codex ★ 41 823звёзд репо cloud-infrastructure-network-engineer Субагент проектирует облачные сети, устраняет сбои маршрутизации и настраивает балансировку трафика. Помогает при развёртывании VPC, VPN-шлюзов и service mesh. CX Codex ★ 41 823звёзд репо hybrid-cloud-architect Проектирует гибридную инфраструктуру с публичными и частными облаками. Зовите его для выбора размещения нагрузок, настройки связности или планирования миграции. CX Codex ★ 41 823звёзд репо

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

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