jschoubben
702efca6bb
HQ held only the to-be. Every reader had to already know the system the decisions were about, and an as-is claim had nowhere to live except inside an intention. Adds 02-DESIGN/00-as-is — eleven documents written from the implementation and the operational record, not from intent, including the parts nobody would choose again. The two existing designs move under 01-to-be. Layers are declared in frontmatter and never mix: a design that ships does not move, its as-is counterpart is written, and both stand. Back-fills adr/0001-0014 for decisions taken in implementation and never recorded — the broker, the module abstraction, the mesh database, managed files, provisioning, migrations, the workspace removal, failing loudly, the constitution, application placement, linking, the employee model, the artifact, the three silos. Each marked reconstructed, dated from the history, and citing the evidence it was recovered from. The two existing records renumber to 0015 and 0016 so the ledger runs oldest first; 0017 extends 0015 to modules outside the core, principle only — the domain list is deliberately not invented here. how-we-build.md becomes the source of the mesh constitution, with a sync playbook, so the enforced copy stops being the only one that is true. Process becomes explicit: five playbooks, eight thin skills that defer to them, a repository map, and AGENTS.md with CLAUDE.md as its include. The five Observations become 04-ISSUES 001-005 where they can be owned and closed. 006 is new and uncomfortable: HQ is not indexed into the knowledge base. That claim is what decision 27 rests on, it was never checked, and the README now says so instead of repeating it. Also corrects the ADR index into something generated, the "02-DESIGN is empty" claim, the VISION.md pointer that did not survive the repo split, and a note asserting the symlink rule was contradicted — it was a misreading; the rule forbids hand-made links, the installer links by design.
47 lines
2.1 KiB
Markdown
47 lines
2.1 KiB
Markdown
---
|
|
name: hal-amend-design
|
|
description: Use when a hal-hq design document must change, or when an as-is document is found to be wrong about what the mesh actually does. Triggers on "the design changed", "that's not how it works any more", "update the as-is", "this shipped differently".
|
|
---
|
|
|
|
# hal-amend-design
|
|
|
|
Changes a design document. **Authoritative playbook:**
|
|
[`00-GENESIS/process/02-graduation.md`](../../../00-GENESIS/process/02-graduation.md).
|
|
|
|
## Which layer is being changed
|
|
|
|
**Establish this first — the two amend for opposite reasons.**
|
|
|
|
| Layer | Amend when | Requires |
|
|
|---|---|---|
|
|
| `01-to-be/` | The intention changed | A decision record. Always. |
|
|
| `00-as-is/` | The mesh changed, or the document was wrong about it | Evidence from the implementation. Never a decision. |
|
|
|
|
An as-is document is corrected against **what the code does**, not against what anyone meant.
|
|
If the implementation and the intention disagree, the as-is document records the implementation
|
|
and says they disagree.
|
|
|
|
## Amending the to-be layer
|
|
|
|
1. Write the decision record. If it reverses an earlier one, that record gets
|
|
`status: superseded` and `superseded-by:` — its text is never edited.
|
|
2. Edit the design; set `updated:` to today.
|
|
3. If this came from an issue, set that issue's `amended-design:`.
|
|
4. Add the ledger line to `DECISIONS.md`.
|
|
|
|
## Amending the as-is layer
|
|
|
|
1. Establish what is actually true — from the code, a pipeline log, a live query, the
|
|
operational record. Not from a design document.
|
|
2. Edit the document. Set `updated:` only if the **implementation state** changed; a
|
|
correction to text that was always wrong does not change it.
|
|
3. If the correction reveals that something shipped differently from its design, say so in the
|
|
as-is document and leave the to-be document alone. That divergence is a finding, and may
|
|
deserve an issue.
|
|
|
|
## Do not
|
|
|
|
- Do not put a future intention in an as-is document.
|
|
- Do not quietly fix a wrong claim that held up a decision. Record that it was wrong and where
|
|
it was relied on — that is the failure this repository exists to name.
|