templates / Architecture template
DocsTemplatesArchitecture template

Architecture template

Explain how the system is built and why. Prefer a diagram plus the reasoning over a list of files. Delete every template comment before committing.

1 min readTemplates
markdown
---
title: {{title}}
description: {{description}}
type: architecture
since: {{since}}
---

<!-- template: explain how the system is built and why. Prefer a diagram plus the reasoning over a list of files. Delete every template comment before committing. -->

## Overview

What the system (or component) is for, in a short paragraph.

## Goals and constraints

- <goal>
- <constraint>

## Components

| Component | Responsibility | Technology |
| --- | --- | --- |
| <name> | <what it owns> | <stack> |

## How it fits together

```mermaid
flowchart LR
  A[Client] --> B[Service]
  B --> C[(Database)]
```

Walk through one request or one flow end to end.

## Data

What is stored, where, and who may change it.

## Security

Trust boundaries, authentication, secrets.

## Decisions and trade-offs

| Decision | Why | Alternative rejected |
| --- | --- | --- |
| <decision> | <reason> | <option and why not> |

## Related

- [<Related document>](./related.md)