jschoubben
fdd909ec40
An object-store provision, proven against a real store with seven assertions. The finding is worth more than the task: the control plane special-cases nothing. provides, requires, contributes and grants are name-agnostic, so asking for a bucket needed no change to the mesh at all. What was missing was a provider and the last step on the machine — "add an object-store provision" was never mesh work, and the breakdown now says so rather than leaving the next person to rediscover it. Named s3-bucket by 0027: the coupling is to the API, not the product, because swapping one store for another does not break a consumer. A database is the other case and names its engine. Records the assertion a database does not need, because it is the one that will be forgotten when somebody writes the next provider: one store holds every bucket behind one endpoint, so isolation is a policy rather than a property, and a policy granting everything passes every test that only checks a consumer can reach its own bucket.
03-DESIGN
The authoritative specification. Implementation is built against what is written here.
Two layers
| Folder | What it is |
|---|---|
00-as-is/ |
The mesh that exists today. Shipped behaviour, described as it is — including behaviour nobody would choose again. |
01-to-be/ |
The mesh being built toward. Every statement traceable to a record in 02-DECISIONS/. |
They are never mixed. A statement about the future does not belong in an as-is document, and an as-is document is never edited to describe an intention.
When a to-be design ships, it does not move. Its as-is counterpart is written or updated,
the to-be document's status becomes implemented, and both stand — one describing what runs,
the other recording what was intended. Deleting the intention loses the reasoning, which is
the expensive half.
Frontmatter
Every design document (not the READMEs) carries:
---
layer: as-is | to-be
status: designed | in-progress | implemented | abandoned
code: [] # owning code repo(s), from 00-META/repos.md
updated: YYYY-MM-DD # date of the last status change, not of text edits
decisions: [] # 02-DECISIONS/ records this document rests on
---
For an as-is document, status: implemented is the normal state — it describes something that
runs — and code: names where that implementation lives.
Status changes when implementation state changes, never because design text was edited. An
implemented claim must be defensible from the owning repository's main branch, not from
intent. If it cannot be checked, it is in-progress.
Cross-cutting views are generated from this frontmatter by the hq-status skill and never
written to disk.
What belongs here
Functional analysis, architectural description, and specification — prose and diagrams
only, no code. A manifest field may be named; a manifest may not be pasted. A document
enters the to-be layer only after the decision behind it is recorded in 02-DECISIONS/
and the research that produced it is closed.
Subfolders are encouraged where a layer grows enough to need them.