Create Architecture Documentation
Generate comprehensive architecture documentation with diagrams, ADRs, and interactive visualization
$ npx claude-code-templates@latest --command="documentation/create-architecture-documentation" --yesRequires Claude Code. The command adds this command to your project's .claudedirectory — nothing runs on ToolZip's servers.
What's inside this command
Component source
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
- 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
- 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
- System Context Documentation
- Document external systems and integrations
- Define system boundaries and responsibilities
- Document user personas and stakeholders
- Create system landscape and ecosystem overview
- Container and Service Architecture
- Create service dependency maps and communication patterns
- Document deployment architecture and infrastructure
- Define service boundaries and API contracts
- Document data persistence and storage architecture
- Component and Module Documentation
- Document internal module structure and relationships
- Define component responsibilities and interfaces
- Document design patterns and architectural styles
- Create code organization and package structure documentation
- Data Architecture Documentation
- 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
- Security and Compliance Architecture
- Create authentication and authorization flow diagrams
- Document compliance requirements and controls
- Define security boundaries and trust zones
- Create incident response and security monitoring documentation
- Quality Attributes and Cross-Cutting Concerns
- Create reliability and availability architecture documentation
- Document monitoring and observability architecture
- Define maintainability and evolution strategies
- Create disaster recovery and business continuity documentation
- Architecture Decision Records (ADRs)
- 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
- Documentation Automation and Maintenance
- 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
Related Claude Code Commands
Update Docs
Systematically update project documentation with implementation status, API changes, and synchronized content
Generate Api Documentation
Auto-generate API reference documentation with multiple output formats and automated deployment
Docs Maintenance
Use PROACTIVELY to implement comprehensive documentation maintenance systems with quality assurance, validation, and automated updates
Create Onboarding Guide
Create comprehensive developer onboarding guide with environment setup, workflows, and interactive tutorials
Doc Api
Generate comprehensive API documentation from code with interactive examples and testing capabilities
Troubleshooting Guide
Generate systematic troubleshooting documentation with diagnostic procedures, common issues, and automated solutions
Catalog data and component content are sourced from the open-source davila7/claude-code-templates project (MIT license). ToolZip curates the listing and writes original descriptions; every component links back to its original source. Claude Code is a product of Anthropic. ToolZip is an independent catalog and is not affiliated with or endorsed by Anthropic.