| name | design-high-level |
| description | Produce a high-level architecture design from a requirements document. |
| metadata | {"author":"cascadian-gamers","version":"1.0"} |
High Level Design
Produce a high-level architecture design from a requirements document.
Mode
- interactive (default): Full standalone workflow. Reads from
Docs/requirements/, saves to Docs/designs/{feature-name}-hld.md.
- spec: Called by
create-spec. Reads the Requirements section from the unified spec, produces the ## 2. High-Level Design section in the same file.
Workflow
- Interactive mode: Look for requirements docs in
Docs/requirements/. If multiple exist, ask the user which one to use.
Spec mode: Read the ## 1. Requirements section from the unified spec passed by the orchestrator.
- Read the requirements document thoroughly.
- Ask the user if they have any additional commentary, design decisions already made, or constraints not in the requirements.
- Produce a high-level design document at
Docs/designs/{feature-name}-hld.md (interactive mode) or as the ## 2. High-Level Design section of the unified spec (spec mode) covering:
Output Format
# High Level Design: {Feature Name}
## Overview
Brief summary of what this design achieves.
## Architecture
### System Context
How this fits into the existing system. Include a Mermaid diagram:
```mermaid
graph LR
...
Architectural Decisions
| Decision | Choice | Rationale | Alternatives Considered |
|---|
| ... | ... | ... | ... |
Major Modules
Description of each major component/module and its responsibility.
Data Flow
How data moves through the system. Include a Mermaid sequence or flow diagram:
sequenceDiagram
...
Data Model
How data is structured and stored. Include entity relationships if applicable.
API Design
High-level API surface — endpoints, protocols, authentication.
Security Concerns
- Authentication and authorization approach
- Data protection (at rest, in transit)
- Input validation strategy
- Threat model considerations
Infrastructure
Cloud resources, deployment topology, scaling approach.
Dependencies
External services, libraries, or teams this depends on.
Risks and Mitigations
| Risk | Impact | Likelihood | Mitigation |
|---|
| ... | ... | ... | ... |
Requirements Traceability
Map design components back to requirement IDs (FR-1, NFR-2, etc.)
5. Present the document to the user for review before saving.
## Rules
- Use Mermaid diagrams for architecture, data flow, and sequence diagrams.
- Every architectural decision must have a rationale and alternatives considered.
- Trace back to requirements — every FR/NFR should be addressed.
- Don't design implementation details — that's for the low-level design.
- If a combined spec exists in `Docs/In-Progress/`, note that HLD findings should be consolidated back into it after review. In spec mode, this is automatic — the HLD is already in the unified spec.
- Refer to the user as "The Brougham 22".