Templates
Purpose
Copy paste stubs for the system. Templates must match the contracts in the module pages.
Rule: templates are minimal but complete. If a field is unknown, write UNKNOWN explicitly rather than deleting it.
Jump
Project template
Links:
- Contract: Project
project:
project_id: "proj_id_stable"
title: "Human readable title"
home: "UNKNOWN" # project home bucket
repo_paths:
- "UNKNOWN"
default_mode: "UNKNOWN" # PIPELINE | TOOLSMITH | SERVICE | CONTRACT | GOVERNANCE | CONTACT
owner_type: "UNKNOWN" # human | machine | mixed
state: "active" # active | paused | archived
cadence:
frequency_days: 7
overdue_behavior: "catch-up-checkin"
tags: []
owner: "matias"
next_checkin_due: "UNKNOWN" # ISO date or timestamp
notes: "One sentence: what this project is for"
VACChain template
Links:
- Contract: VACChain
vac_chain:
vac_id: "vac_id_stable"
project_id: "proj_id_stable"
description: "Value statement: what exists in the world if this works"
owner_type: "UNKNOWN" # human | machine | mixed
prerequisites:
- "UNKNOWN"
endpoints:
- "endpoint_id_1"
- "endpoint_id_2"
notes: "Optional: why this VAC matters"
Endpoint template
Links:
- Contract: Endpoint
- Evidence pointers: EvidenceLink
- Check taxonomy: Check types
endpoint:
endpoint_id: "endpoint_id_stable"
vac_id: "vac_id_stable"
title: "Short description of the done-claim"
type: "UNKNOWN" # pipeline | deploy | service | content_quality | contract
severity: "medium" # critical | high | medium | low
check_method:
check_type: "smoke" # smoke | run_live_bounded | contract_test | health_check | content_validation
command: "UNKNOWN" # exact command or pointer (make target, script, CLI)
timebox_minutes: 15
scope: "fixture" # fixture | live
bounds:
max_rows: null
max_items: null
rate_limit: null
dry_run: true
artifacts_expected:
- "UNKNOWN" # paths/globs for artifacts produced by successful check
freshness_policy:
max_age_days: 7
evidence_required:
logs: true
manifest: true
artifacts: true
acceptance_criteria:
- "Exit code is 0"
- "Artifacts expected exist and are non-empty"
- "Content validation gates pass (if defined)"
failure_paths:
- "If FAIL: create DebugPacket and schedule CONTRACT block"
- "If WARN: schedule MAINT to clear missing prereq/runbook/evidence"
notes: "Optional: special rules"
Operator template
Links:
- Contract: Operator
- Checks: Checks and Runbooks
operator:
op_id: "op_id_stable"
name: "Human readable operator name"
mode_ids:
- "UNKNOWN" # PIPELINE | TOOLSMITH | SERVICE | CONTRACT | GOVERNANCE | CONTACT
purpose: "One sentence: what this operator achieves"
inputs:
- name: "project_id"
type: "ProjectRef"
required: true
- name: "repo_path"
type: "Path"
required: false
- name: "params"
type: "Map"
required: false
steps:
- "Step 1"
- "Step 2"
- "Step 3"
outputs:
artifacts:
- "UNKNOWN" # paths/globs
logs:
- "UNKNOWN"
manifests:
- "UNKNOWN"
acceptance_checks:
- check_type: "content_validation"
command: "UNKNOWN"
- check_type: "smoke"
command: "UNKNOWN"
timebox_minutes: 60
failure_paths:
- "If blocked: write next pointer and stop"
- "If drifting: create DebugPacket"
- "If regression risk: add guardrail (test/gate) before declaring PASS"
evidence_pattern: "UNKNOWN" # link or short label; must match mode evidence pattern
next_pointer_rule: "One line: what must be written at end of run"
OpRun template
Links:
- Contract: OpRun
- Evidence pointers: EvidenceLink
op_run:
op_id: "op_id_stable"
project_id: "proj_id_stable"
mode_id: "UNKNOWN"
timestamp_start: "UNKNOWN"
timestamp_end: "UNKNOWN"
inputs_used:
- "UNKNOWN"
outputs_written:
- "UNKNOWN"
acceptance_results:
- check_type: "smoke"
status: "UNKNOWN" # PASS | WARN | FAIL
evidence_links:
- "UNKNOWN"
- check_type: "content_validation"
status: "UNKNOWN"
evidence_links:
- "UNKNOWN"
result: "UNKNOWN" # PASS | WARN | FAIL
evidence_links:
- "UNKNOWN"
next_pointer: "One line next action"
DebugPacket template
Links:
- Contract: DebugPacket
debug_packet:
project_id: "proj_id_stable"
symptom: "Observable failure in one line"
context: "What changed recently (optional)"
minimal_repro:
commands:
- "UNKNOWN"
inputs:
- "UNKNOWN"
expected: "UNKNOWN"
actual: "UNKNOWN"
logs:
- "UNKNOWN"
hypotheses:
- "H1"
- "H2"
- "H3"
experiments:
- change: "What you changed"
result: "What happened"
evidence:
- "UNKNOWN"
- change: "UNKNOWN"
result: "UNKNOWN"
evidence:
- "UNKNOWN"
decision: "What you conclude right now"
resolution_or_next: "Fix applied OR next experiments to run"
regression_guard: "Test/gate/check added OR TODO"
time_spent_minutes: 40
RunbookHuman template
Links:
- Spec: Runbooks
## RunbookHuman: <project_id>
Purpose:
- Why this project exists and what “done” means (tie to endpoints)
Exports:
- What artifacts this project produces
How to run (human checklist):
1) ...
2) ...
PASS/WARN/FAIL actions:
- If PASS: ...
- If WARN: ...
- If FAIL: ...
Common failures:
- Symptom -> likely cause -> fix
Next pointers:
- After a normal session: ...
- After a blocked session: ...
Cadence and ownership:
- Cadence: every X days
- Owner: matias
RunbookMachine template
Links:
- Spec: Runbooks
## RunbookMachine: <project_id>
Entry points:
- `make smoke`
- `make run-live`
- `python -m ...`
Environment:
- Required env vars:
- `VAR=...`
- Optional env vars:
- `VAR=...`
Inputs:
- Fixtures: `...`
- Live sources: `...`
Outputs:
- Artifacts directory: `...`
- Logs: `...`
- Manifests: `...`
Validation:
- Smoke command: `...`
- Content validation: `...`
- Health check: `...`
Exit codes:
- 0 = PASS
- 1/2/... = FAIL meaning
Safety bounds:
- Timebox: ...
- Dry-run: ...
- Rate limits: ...
Daily brief template
Links:
- Clock: Run a day
- Evidence conventions: Evidence and manifests
Use this as the smallest daily artifact that preserves continuity.
## Daily brief: YYYY-MM-DD
Energy: low | medium | high
Available blocks: <count> (MAINT/FOCUS)
Frontier snapshot (top 3):
- <project_id>: PASS/WARN/FAIL (why)
- <project_id>: PASS/WARN/FAIL (why)
- <project_id>: PASS/WARN/FAIL (why)
Selected first block:
- Block type: MAINT | FOCUS
- Mode: <MODE>
- Project: <project_id>
- Planned operator: <op_id or name>
- Expected evidence: <one line>
- Stop rule: <one line>
Executed:
- OpRun: <op_id> -> PASS/WARN/FAIL
- Evidence: <links>
Next pointer:
- <one line>
Notes:
- <optional: constraint or decision>