К основному содержанию
команда

create-architecture-documentation — команда для Claude Code

Слэш-команда для Claude, которая собирает документацию по архитектуре проекта: диаграммы, ADR и описание компонентов.

Установить в Claude Code · Через claude-code-templates Все способы и платформы ↓
npx claude-code-templates@latest --command documentation/create-architecture-documentation
Открыть на GitHub

Что делает create-architecture-documentation

Команда проходит по репозиторию и собирает контекст сама: ищет конфиги (*.json, *.yaml, *.toml), файлы с именами вроде *architecture* или *design*, docker-compose.yml, манифесты k8s/, описания API (*openapi*, *swagger*). Дальше на этой основе предлагает разложить систему по слоям — контекст, контейнеры, компоненты, код.

Формат документации выбирается аргументом: --c4-model, --arc42, --adr, --plantuml или --full-suite. Можно передать название фреймворка первым аргументом. Инструменты у команды ограничены чтением, записью, правкой файлов и Bash, поэтому диаграммы она делает как код, а не картинками.

Список того, что она пытается задокументировать, широкий: границы сервисов, потоки данных, схемы БД, безопасность, наблюдаемость, решения с обоснованием. Если в проекте нет ни docker-compose.yml, ни k8s/, ни описаний API, контекст будет куцым — команда всё равно отработает, но часть разделов останется на общих словах. Это повод сначала проверить, что в репозитории вообще есть чем её накормить.

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

  • описать существующую систему по слоям C4
  • зафиксировать архитектурные решения и их обоснование
  • собрать диаграммы как код, а не рисовать их руками
  • разложить сервисы и их зависимости по карте
  • подготовить документацию к передаче команде или заказчику

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

  • /create-architecture-documentation --c4-model
  • /create-architecture-documentation --adr
  • /create-architecture-documentation --full-suite

Как установить create-architecture-documentation

1Через claude-code-templates

npx claude-code-templates@latest --command documentation/create-architecture-documentation

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

.claude/commands/create-architecture-documentation.md

Вызов — /create-architecture-documentation. Для всех проектов — ~/.claude/commands/

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

Весь набор →
backend-architect Субагент для проектирования бэкенда: границы сервисов, выбор API-парадигмы, схемы БД и наблюдаемость. Полезен, когда решение нужно принять до первой строки кода. 23 691установок ultra-think Запускает многошаговый разбор задачи: вскрывает скрытые допущения, предлагает конкурирующие варианты и проверяет каждый на прочность. Пригодится, когда решение дорогое и не хочется ошибиться. 8 383установок documentation-expert Субагент создаёт, обновляет и поддерживает документацию проекта, включая README, API-описания и руководства. Пригодится для работы с документацией из кода. 6 992установок task-decomposition-expert Проектирует иерархическую структуру работ, выявляет критический путь и распределяет этапы между профильными агентами. Помогает спланировать запуск сложных систем до написания кода. 6 870установок mcp-expert Проектирует и настраивает серверы Model Context Protocol для интерфейса Claude Code. Помогает подключить базы данных, внешние API или локальную файловую систему. 6 052установок nextjs-architecture-expert Субагент для Claude, который разбирает архитектуру Next.js: App Router, Server Components, миграцию и производительность. 4 935установок refactor-code Слэш-команда ведёт агента по 17 шагам рефакторинга: от анализа и тестов до проверки производительности и подготовки к ревью. 4 890установок seo-analyzer Субагент для технического SEO-аудита, разбора метатегов и Core Web Vitals. Пригодится, когда нужно проверить структуру сайта и получить список правок по приоритету. 4 060установок

Похожие

architecture-diagrams aj-geddes Скилл помогает генерировать схемы архитектуры, потоки данных и C4-диаграммы в текстовом формате Mermaid или PlantUML. Пригодится при оформлении технической документации прямо в чате с агентом. CX Codex +1 2 000установок architecture официальный anthropics Помогает оформить Architecture Decision Record или разобрать чужой дизайн системы: варианты, компромиссы, последствия. Пригодится, когда выбираете между технологиями. CX Codex +1 6 700установок documentation-and-adrs addyosmani Скилл помогает фиксировать архитектурные решения (ADR), причины выбора технологий и контекст для будущих разработчиков или агентов в репозитории. CX Codex +1 63 800установок create-architecture Donchitos Скилл создаёт технический проект docs/architecture/architecture.md на основе дизайн-документов до написания кода. Помогает согласовать слои системы и найти пробелы в архитектурных решениях. CX Codex +1 422установок architecture-decision-records affaan-m Скилл записывает архитектурные решения в нумерованные ADR-файлы в docs/adr/ с контекстом, альтернативами и последствиями. Пригодится, когда выбираете фреймворк или базу и не хотите терять причину выбора. CX Codex +1 4 900установок project-documenter официальный Awesome Copilot Community Создаёт документацию репозитория в Markdown и Word, добавляя схемы draw.io и PNG-изображения. Нужен, когда кодовую базу требуется описать по её реальной структуре. ★ 40 418звёзд репо create-cowork-plugin официальный anthropics Скилл ведёт через создание плагина с нуля: от уточнения задачи до готового файла .plugin. Нужен для проектирования своих расширений. CX Codex +1 2 900установок golang-documentation samber Скилл настраивает стандарты документации в Go-проектах: от godoc-комментариев и Example-тестов до README и llms.txt. Пригодится при оформлении библиотек и CLI перед релизом. CX Codex +1 40 400установок

Рядом в каталоге

Все слэш-команды по теме «Тексты и документация» →

Вопросы о create-architecture-documentation

Как установить create-architecture-documentation в Claude?

Через шаблоны: npx claude-code-templates@latest --command documentation/create-architecture-documentation. После этого файл команды лежит в .claude/commands/create-architecture-documentation.md.

Что делает create-architecture-documentation?

Анализирует структуру проекта и генерирует документацию по архитектуре: диаграммы, описание компонентов и записей о решениях. Формат задаётся аргументом вроде --c4-model или --arc42.

Какие форматы документации поддерживаются?

C4 Model, Arc42, ADR, PlantUML и режим --full-suite, который собирает всё сразу. Выбор передаётся аргументом при вызове команды.

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

create-architecture-documentation.md · MIT
---
allowed-tools: Read, Write, Edit, Bash
argument-hint: "[framework] | --c4-model | --arc42 | --adr | --plantuml | --full-suite"
description: Generate comprehensive architecture documentation with diagrams, ADRs, and interactive visualization
---

# Architecture Documentation Generator

Generate comprehensive architecture documentation: $ARGUMENTS

## Current Architecture Context

- Project structure: !`find . -type f -name "*.json" -o -name "*.yaml" -o -name "*.toml" | head -5`
- Documentation exists: @docs/ or @README.md (if exists)
- Architecture files: !`find . -name "*architecture*" -o -name "*design*" -o -name "*.puml" | head -3`
- Services/containers: @docker-compose.yml or @k8s/ (if exists)
- API definitions: !`find . -name "*api*" -o -name "*openapi*" -o -name "*swagger*" | head -3`

## Task

Generate comprehensive architecture documentation with modern tooling and best practices:

1. **Architecture Analysis and Discovery**
   - Analyze current system architecture and component relationships
   - Identify key architectural patterns and design decisions
   - Document system boundaries, interfaces, and dependencies
   - Assess data flow and communication patterns
   - Identify architectural debt and improvement opportunities

2. **Architecture Documentation Framework**
   - Choose appropriate documentation framework and tools:
     - **C4 Model**: Context, Containers, Components, Code diagrams
     - **Arc42**: Comprehensive architecture documentation template
     - **Architecture Decision Records (ADRs)**: Decision documentation
     - **PlantUML/Mermaid**: Diagram-as-code documentation
     - **Structurizr**: C4 model tooling and visualization
     - **Draw.io/Lucidchart**: Visual diagramming tools

3. **System Context Documentation**
   - Create high-level system context diagrams
   - Document external systems and integrations
   - Define system boundaries and responsibilities
   - Document user personas and stakeholders
   - Create system landscape and ecosystem overview

4. **Container and Service Architecture**
   - Document container/service architecture and deployment view
   - Create service dependency maps and communication patterns
   - Document deployment architecture and infrastructure
   - Define service boundaries and API contracts
   - Document data persistence and storage architecture

5. **Component and Module Documentation**
   - Create detailed component architecture diagrams
   - Document internal module structure and relationships
   - Define component responsibilities and interfaces
   - Document design patterns and architectural styles
   - Create code organization and package structure documentation

6. **Data Architecture Documentation**
   - Document data models and database schemas
   - Create data flow diagrams and processing pipelines
   - Document data storage strategies and technologies
   - Define data governance and lifecycle management
   - Create data integration and synchronization documentation

7. **Security and Compliance Architecture**
   - Document security architecture and threat model
   - Create authentication and authorization flow diagrams
   - Document compliance requirements and controls
   - Define security boundaries and trust zones
   - Create incident response and security monitoring documentation

8. **Quality Attributes and Cross-Cutting Concerns**
   - Document performance characteristics and scalability patterns
   - Create reliability and availability architecture documentation
   - Document monitoring and observability architecture
   - Define maintainability and evolution strategies
   - Create disaster recovery and business continuity documentation

9. **Architecture Decision Records (ADRs)**
   - Create comprehensive ADR template and process
   - Document historical architectural decisions and rationale
   - Create decision tracking and review process
   - Document trade-offs and alternatives considered
   - Set up ADR maintenance and evolution procedures

10. **Documentation Automation and Maintenance**
    - Set up automated diagram generation from code annotations
    - Configure documentation pipeline and publishing automation
    - Set up documentation validation and consistency checking
    - Create documentation review and approval process
    - Train team on architecture documentation practices and tools
    - Set up documentation versioning and change management

© davila7 · MIT · davila7/claude-code-templates

Смотрите также

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

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