Write Design Document
sdd_write_designGenerates a DESIGN.md file with architecture overview, Mermaid diagrams, ADRs, and API contracts for structured system design.
Instructions
Generates and writes DESIGN.md with architecture overview, Mermaid diagrams, ADRs, and API contracts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| architecture_overview | Yes | High-level architecture description | |
| mermaid_diagrams | Yes | Mermaid diagrams | |
| adrs | No | Architecture Decision Records | |
| api_contracts | No | API contracts | |
| system_context | No | System context: who uses the system and what external systems it integrates with (C4 Level 1) | |
| container_architecture | No | Container architecture: deployable units and communication patterns (C4 Level 2) | |
| component_design | No | Component design: internal modules/services and responsibilities (C4 Level 3) | |
| code_level_design | No | Code-level design: key classes, interfaces, and patterns (C4 Level 4) | |
| data_models | No | Data model: entities, relationships, and storage strategy | |
| infrastructure | No | Infrastructure: deployment, scaling, monitoring, and operations | |
| security_architecture | No | Security: authentication, authorization, encryption, and threat model | |
| error_handling | No | Error handling: detection, logging, propagation, and recovery | |
| cross_cutting | No | Cross-cutting concerns: logging, monitoring, caching, configuration | |
| spec_dir | No | Spec directory path (relative to workspace root) | .specs |
| feature_number | No | Feature number (zero-padded, e.g. '001') | 001 |
| force | No | Overwrite existing files if true |