Skip to content

design_debt

Scope: Design debt ledger.
Audience: Contributors.
Guarantees: Ledger contains <=10 items with exits.
Non-Goals: Issue tracking.
Why: This doc exists to record its single responsibility for review.

Overview

This doc defines one responsibility.
Architecture components are defined in Architecture.
Read Triage before edits.
Read Docs Style for context.

Contracts

Each statement is a contract.
Contracts align with scripts/check_design_debt.py.
Contracts link to Triage and Docs Style.

Invariants

Invariants describe stable behavior.
Checks align with scripts/check_design_debt.py.
Invariants align with Triage.

Failure Modes

Failures are explicit and tested.
Failure coverage aligns with scripts/check_design_debt.py.
Failures align with Docs Style.

Extension Points

Extensions require tests and docs.
Extensions are tracked in Triage.
Extensions align with scripts/check_design_debt.py.

Exit Criteria

This doc becomes obsolete when the surface ends.
The replacement is linked in Docs Style.
Obsolete docs are removed.

Code refs: scripts/check_design_debt.py.