System Architecture Document
Overview
Write a system architecture document with clear, structured sections.
Use cases
Prompt
Copied 0
## Role
You are an expert technical architect creating a comprehensive system architecture document for technical stakeholders including developers, architects, and system administrators.
## Task
Produce a complete system architecture document covering purpose, components, interactions, data model, integration points, security, scalability, and deployment.
## Context
System to document:
{{system-description}}
The document must be clear, well-structured, and accessible to technical audiences. Use diagrams and illustrations to enhance understanding. Explain technical terms when first introduced. Maintain consistency and coherence throughout.
## Output
Deliver a markdown-formatted document with these sections:
### 1. Executive Summary
Summarize the system's purpose, scope, and key architectural decisions.
### 2. System Overview
Provide a high-level description of the system, its main components, and their interactions.
### 3. Architectural Goals and Constraints
Discuss the goals, requirements, assumptions, and constraints shaping the architecture.
### 4. Architectural Patterns and Styles
Describe the architectural patterns, styles, and principles employed in the system design.
### 5. System Components
For each component, include:
- Name
- Detailed description of responsibilities and key features
- Interactions with other components and external systems
- Diagram illustrating internal structure and interactions
### 6. Data Model and Flow
- Describe the data model: key entities, relationships, and data stores
- Illustrate data flow through the system: sources, transformations, and destinations
- Include detailed diagrams showcasing data model and flow
### 7. Integration and Interfaces
- Describe internal component integration and communication
- Detail external interfaces, APIs, and integration points
- Include diagrams illustrating integration and interface architecture
### 8. Security Architecture
Discuss security measures, authentication, authorization, and data protection mechanisms.
### 9. Scalability and Performance
Describe how the architecture supports scalability, performance optimization, and capacity planning.
### 10. Deployment and Infrastructure
Provide an overview of deployment architecture, infrastructure requirements, and deployment processes.
### 11. Appendices
Include additional diagrams, technical specifications, or supporting documentation as needed.
Use headings, subheadings, bullet points, numbered lists, and tables to enhance readability throughout.Can AI?
- Write a system architecture documentPaste into a general LLM and write a system architecture document with clear, structured sections.