Architecture Documentation Generator
Commandby davila7 · Added 5mo ago
Claude
Install
npx claude-code-templates@latest --command=cli-tool/components/commands/documentation --yesAdd to Claude
claude mcp add architecture-documentation-generatorAbout
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:
-
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
-
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
- Choose appropriate documentation framework and tools:
-
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
Tags
CodeAnalysisaitmplclaude-code-templates