Create Architecture Documentation

Generate comprehensive architecture documentation

Instructions

1. Architecture Analysis and Discovery
2. Analyze current system architecture and component relationships
3. Identify key architectural patterns and design decisions
4. Document system boundaries, interfaces, and dependencies
5. Assess data flow and communication patterns

6. Identify architectural debt and improvement opportunities

7. Architecture Documentation Framework

8. 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

9. System Context Documentation

10. Create high-level system context diagrams
11. Document external systems and integrations
12. Define system boundaries and responsibilities
13. Document user personas and stakeholders

14. Create system landscape and ecosystem overview

15. Container and Service Architecture

16. Document container/service architecture and deployment view
17. Create service dependency maps and communication patterns
18. Document deployment architecture and infrastructure
19. Define service boundaries and API contracts

20. Document data persistence and storage architecture

21. Component and Module Documentation

22. Create detailed component architecture diagrams
23. Document internal module structure and relationships
24. Define component responsibilities and interfaces
25. Document design patterns and architectural styles

26. Create code organization and package structure documentation

27. Data Architecture Documentation

28. Document data models and database schemas
29. Create data flow diagrams and processing pipelines
30. Document data storage strategies and technologies
31. Define data governance and lifecycle management

32. Create data integration and synchronization documentation

33. Security and Compliance Architecture

34. Document security architecture and threat model
35. Create authentication and authorization flow diagrams
36. Document compliance requirements and controls
37. Define security boundaries and trust zones

38. Create incident response and security monitoring documentation

39. Quality Attributes and Cross-Cutting Concerns

40. Document performance characteristics and scalability patterns
41. Create reliability and availability architecture documentation
42. Document monitoring and observability architecture
43. Define maintainability and evolution strategies

44. Create disaster recovery and business continuity documentation

45. Architecture Decision Records (ADRs)

46. Create comprehensive ADR template and process
47. Document historical architectural decisions and rationale
48. Create decision tracking and review process
49. Document trade-offs and alternatives considered

50. Set up ADR maintenance and evolution procedures

51. 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