Handoff corpus¶
Generated from a canonical source
This page is a read-only projection of docs/handoff-corpus/README.md.
Edit the canonical file, then run npm --prefix tools/project-knowledge-derive run derive.
The third-party handoff: what a colleague or agency reads to evaluate, take over, or extend this system cold. One page per capability domain, each telling four things — what it's for, how it actually works, where intent and reality diverge, and how to operate & extend it — with every claim cited to an openable source.
This corpus is generated, per the ratified Input-B contract
(docs/methodology/handoff-corpus-input-spec.md):
Input-A (the code, read fresh at generation time)
Input-B (_input-b/<domain>.md — intent, rationale, typed deltas, attestations)
└────────────── generation prompt ──────────────┘
↓
<domain>.md (this directory)
How a domain page comes to exist¶
- Author the Input-B file from
_input-b/_TEMPLATE.md: feature descriptors, load-bearing decisions, the invariant, typed deltas (six-type vocabulary), visual-aid pointers, evidence pointers — and the two attestations, produced by the contract's tracing procedures (trace first; never recollection). - Operator ratifies the attestations (
status: draft → attested,ratified_by/ratified_onset). Generation is blocked until then. - Generate with
docs/methodology/prompts/handoff-generation.md— a fresh agent composes Input-A + Input-B into the page, validated againsthandoff-voice.md. - Lint:
npx tsx tools/handoff-lint/index.ts(mechanical half — structure, delta types, attestation freshness); voice/citation quality stays a human/agent review. - Maintain: re-attest and regenerate when the architecture, its deciding
decisions, or the traced live-state change (the
as_of_commitfrontmatter dates every page).
Reading order for a recipient¶
Start with the domain you're scoping. The proven exemplars (hand-authored
prototypes that set this corpus's bar) live at
handoff-specimen-dunning.md and
handoff-specimen-payments.md
until their generated replacements land here.