Files
wehub-resource-sync bb5c75ce05
Component Security Validation / Security Audit (push) Has been cancelled
Deploy to Cloudflare Pages / deploy (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 12:38:58 +08:00

1 line
4.4 KiB
JSON

{"content": "---\nallowed-tools: Read, Write, Edit, Bash\nargument-hint: \"[framework] | --c4-model | --arc42 | --adr | --plantuml | --full-suite\"\ndescription: Generate comprehensive architecture documentation with diagrams, ADRs, and interactive visualization\n---\n\n# Architecture Documentation Generator\n\nGenerate comprehensive architecture documentation: $ARGUMENTS\n\n## Current Architecture Context\n\n- Project structure: !`find . -type f -name \"*.json\" -o -name \"*.yaml\" -o -name \"*.toml\" | head -5`\n- Documentation exists: @docs/ or @README.md (if exists)\n- Architecture files: !`find . -name \"*architecture*\" -o -name \"*design*\" -o -name \"*.puml\" | head -3`\n- Services/containers: @docker-compose.yml or @k8s/ (if exists)\n- API definitions: !`find . -name \"*api*\" -o -name \"*openapi*\" -o -name \"*swagger*\" | head -3`\n\n## Task\n\nGenerate comprehensive architecture documentation with modern tooling and best practices:\n\n1. **Architecture Analysis and Discovery**\n - Analyze current system architecture and component relationships\n - Identify key architectural patterns and design decisions\n - Document system boundaries, interfaces, and dependencies\n - Assess data flow and communication patterns\n - Identify architectural debt and improvement opportunities\n\n2. **Architecture Documentation Framework**\n - Choose appropriate documentation framework and tools:\n - **C4 Model**: Context, Containers, Components, Code diagrams\n - **Arc42**: Comprehensive architecture documentation template\n - **Architecture Decision Records (ADRs)**: Decision documentation\n - **PlantUML/Mermaid**: Diagram-as-code documentation\n - **Structurizr**: C4 model tooling and visualization\n - **Draw.io/Lucidchart**: Visual diagramming tools\n\n3. **System Context Documentation**\n - Create high-level system context diagrams\n - Document external systems and integrations\n - Define system boundaries and responsibilities\n - Document user personas and stakeholders\n - Create system landscape and ecosystem overview\n\n4. **Container and Service Architecture**\n - Document container/service architecture and deployment view\n - Create service dependency maps and communication patterns\n - Document deployment architecture and infrastructure\n - Define service boundaries and API contracts\n - Document data persistence and storage architecture\n\n5. **Component and Module Documentation**\n - Create detailed component architecture diagrams\n - Document internal module structure and relationships\n - Define component responsibilities and interfaces\n - Document design patterns and architectural styles\n - Create code organization and package structure documentation\n\n6. **Data Architecture Documentation**\n - Document data models and database schemas\n - Create data flow diagrams and processing pipelines\n - Document data storage strategies and technologies\n - Define data governance and lifecycle management\n - Create data integration and synchronization documentation\n\n7. **Security and Compliance Architecture**\n - Document security architecture and threat model\n - Create authentication and authorization flow diagrams\n - Document compliance requirements and controls\n - Define security boundaries and trust zones\n - Create incident response and security monitoring documentation\n\n8. **Quality Attributes and Cross-Cutting Concerns**\n - Document performance characteristics and scalability patterns\n - Create reliability and availability architecture documentation\n - Document monitoring and observability architecture\n - Define maintainability and evolution strategies\n - Create disaster recovery and business continuity documentation\n\n9. **Architecture Decision Records (ADRs)**\n - Create comprehensive ADR template and process\n - Document historical architectural decisions and rationale\n - Create decision tracking and review process\n - Document trade-offs and alternatives considered\n - Set up ADR maintenance and evolution procedures\n\n10. **Documentation Automation and Maintenance**\n - Set up automated diagram generation from code annotations\n - Configure documentation pipeline and publishing automation\n - Set up documentation validation and consistency checking\n - Create documentation review and approval process\n - Train team on architecture documentation practices and tools\n - Set up documentation versioning and change management"}