[Component / System Name]¶

One sentence: what this is and who it's for.

Overview¶

[ASCII or Mermaid diagram showing the big picture]

What	Why it matters
[Key fact 1]	[Plain English reason]
[Key fact 2]	[Plain English reason]

How It Works¶

Step 1 — [Name]¶

[Diagram or flow]

Input: what comes in
Output: what goes out
Who does it: which component/service

Step 2 — [Name]¶

[Diagram or flow]

Input:
Output:
Who does it:

Add as many steps as needed. Keep each one to a single responsibility.

Components¶

[Component A] ──── does what ────► [Component B]
                                        │
                                        ▼
                                   [Component C]

Component	What it does	Lives in
[Name]	[One line]	`path/to/file.py`

Data Flow¶

User
 │  action
 ▼
[Component A]
 │  request
 ▼
[Component B]
 │  response
 ▼
[Component A]
 │  result
 ▼
User

Key Decisions¶

Why was it built this way? What alternatives were considered?

Decision	Chosen approach	Why
[Topic]	[What we do]	[One-line reason]

What Can Go Wrong¶

Failure	Impact	How we handle it
[Scenario]	[What breaks]	[Mitigation]

Glossary¶

Term	Plain English definition
[Term]	[Explain it like the reader has never used this software before]

Last updated: YYYY-MM-DD · Owner: [name or team]