Documentation convention (striatum)
June 29, 2026 · View on GitHub
striatum follows the shared documentation convention single-sourced in
doc-convention-lint and
vendored here, pinned by SHA, via .pre-commit-config.yaml. There is one
convention across striatum + engram; this repo supplies only an extend-only
overlay (./doc-convention.yaml).
This convention is the layout + enforcement companion to
doc-map.md, which remains the concept-ownership contract
("one home per concept, every other doc cites it"). doc-map says which doc owns
a concept; this convention says which shelf a doc lives on and how that is
machine-checked.
The model
Two axes. Curated vs provenance: curated docs are human-intent, mutable,
edited in place; provenance is historical run output, research snapshots,
audits, and retired scaffolds that should remain discoverable without reading
as current guidance. Current curated docs live under docs/how-to/,
docs/reference/, docs/agents/, docs/decisions/, and docs/rfcs/.
docs/operator/, docs/campaigns/, and docs/dogfoods/ are sanctioned
runtime or workflow-fixture regions. docs/audits/ is the browseable audit
corpus. docs/records/_frozen/ is the frozen archival tail.
TL;DR for an agent about to write a doc
- Is this current operator/runtime material?
→ use the existing sanctioned region (
docs/operator/,docs/campaigns/, ordocs/dogfoods/) and keep the directory README accurate. - Is this a whole-repo audit, hygiene report, review, or reconcile report?
→
docs/audits/. - Is this frozen provenance, old research, or an archived run packet?
→
docs/records/_frozen/. - Else it is curated: task guides go in
docs/how-to/, lookup contracts indocs/reference/, agent-facing guidance indocs/agents/, designs indocs/rfcs/, and decisions indocs/decisions/.
Status
Migration Phase 1 — warn-only. The linter reports but does not block.
Striatum keeps a repo-specific overlay because several runtime surfaces are
path contracts, not generic Diataxis shelves. Run
doc-lint lint --all --warn-only to see current drift.