LLD: ¶
status: draft
Low-level design template (backlog B35). Copy to docs/design/LLD-<slug>.md; mmdep design check requires every section below.
Replace the examples. Once Atul approves the design, change status: draft to status: approved; then mmdep design issues <this file> shows (dry run) or opens (--create) one issue per Work items row.
Context¶
What problem this solves and which ADR it follows (for example ADR-0016).
Decision¶
What is built, in a few lines: interfaces, data, where it runs.
C4 element¶
The elements of the C4 model (architecture/workspace.dsl) this touches, each in backticks. A new component goes into the model first.
MMDEP
Diagram¶
Required when more than two parts interact (docs/design/visualization-standard.md): a Mermaid flowchart, sequenceDiagram, stateDiagram or erDiagram. Mark planned or unverified parts.
flowchart LR
A[Caller] --> B[New component] --> C[(Store)]
Test plan¶
- Unit tests for the new behaviour; the contract test that fails before the change.
Risk¶
risk: low
Why, and what would make it higher (contract, secrets, production, money).
Work items¶
| # | Title | Risk | Model | Scope paths | Depends on | Cx | Tests |
|---|---|---|---|---|---|---|---|
| 1 | Example item | low | gemini-flash-lite | mmdep/example.py, tests/test_example.py | 2 | tests/test_example.py | |
| 2 | Example follow-up | low | gemini-flash-lite | docs/example.md | 1 | 1 |