128 lines
1.9 KiB
Markdown
128 lines
1.9 KiB
Markdown
# <Module Name>
|
|
|
|
## Metadata
|
|
|
|
| Field | Value |
|
|
|---|---|
|
|
| Status | Planned / Prototype / Partial / Implemented / Verified / Deprecated |
|
|
| Target/work package | |
|
|
| Owners | |
|
|
| Last verified | `<commit>, YYYY-MM-DD` |
|
|
| Profiles/capabilities | |
|
|
|
|
## Purpose
|
|
|
|
|
|
## Non-goals
|
|
|
|
|
|
## Context and boundaries
|
|
|
|
```mermaid
|
|
flowchart LR
|
|
Input[Input contract] --> Module[Module]
|
|
Module --> Output[Output contract]
|
|
```
|
|
|
|
Allowed dependencies:
|
|
|
|
-
|
|
|
|
Forbidden dependencies:
|
|
|
|
-
|
|
|
|
## Public API
|
|
|
|
| Symbol | Kind | Purpose | Thread/lifetime | Errors |
|
|
|---|---|---|---|---|
|
|
|
|
## Inputs and outputs
|
|
|
|
| Direction | Contract/data | Producer | Consumer | Ownership | Thread/lifetime |
|
|
|---|---|---|---|---|---|
|
|
|
|
Side effects:
|
|
|
|
-
|
|
|
|
## Data flow
|
|
|
|
```mermaid
|
|
flowchart LR
|
|
Source --> Transform --> Result
|
|
```
|
|
|
|
## Lifecycle/state
|
|
|
|
```mermaid
|
|
stateDiagram-v2
|
|
[*] --> Created
|
|
Created --> Ready
|
|
Ready --> Stopped
|
|
Stopped --> [*]
|
|
```
|
|
|
|
## Main sequence
|
|
|
|
```mermaid
|
|
sequenceDiagram
|
|
participant A as Producer
|
|
participant M as Module
|
|
participant B as Consumer
|
|
A->>M: Input
|
|
M-->>B: Output
|
|
```
|
|
|
|
## Ownership, threading and resources
|
|
|
|
|
|
## Errors, cancellation and recovery
|
|
|
|
| Failure | Detection | Behavior | Diagnostic | Recovery |
|
|
|---|---|---|---|---|
|
|
|
|
## Configuration and capabilities
|
|
|
|
| Setting/capability | Default | Profile | Runtime mutable | Effect |
|
|
|---|---|---|---|---|
|
|
|
|
## Persistence, cache and migration
|
|
|
|
|
|
## Diagnostics and observability
|
|
|
|
- Logs:
|
|
- Metrics:
|
|
- Debug views:
|
|
- Correlation IDs:
|
|
|
|
## Verification
|
|
|
|
- Unit/contract tests:
|
|
- Integration/E2E:
|
|
- Fidelity evidence:
|
|
- Performance budgets:
|
|
- Manual diagnostics:
|
|
|
|
## Extension points
|
|
|
|
|
|
## Capability status
|
|
|
|
| Capability | Status | Evidence | Gap/next step |
|
|
|---|---|---|---|
|
|
|
|
## Known gaps and risks
|
|
|
|
|
|
## Source map
|
|
|
|
| Path | Responsibility |
|
|
|---|---|
|
|
|
|
## Related decisions and references
|
|
|
|
- ADR:
|
|
- Upstream/reference:
|