Chapter 17 · build contribute

JSON guide authoring reference

Use stable identifiers, explicit branches, command metadata, owner routes, and measurable resolutions.

1 min read·Updated 2026-07-24·2 role paths
01

Stable anatomy

A guide normally includes identity, title, description, technology domain, diagnostic area, operator phrases, scope guidance, steps, commands, owner routes, and resolution definitions. Follow the repository template and existing schema rather than inventing parallel fields.

02

Step design

Each step needs a stable ID, a clear evidence question, and options whose next target exists. Questions should request observable evidence. Avoid compound questions that can produce two conflicting answers.

json
{
  "id": "affected-peer-comparison",
  "question": "Does the healthy peer show the same controller state?",
  "options": [
    { "id": "same", "label": "Same state", "next": "shared-boundary-check" },
    { "id": "different", "label": "Different state", "next": "local-controller-check" },
    { "id": "unknown", "label": "Not yet known", "next": "collect-peer-state" }
  ]
}
03

Resolution design

A resolution should include diagnosis, supported boundary, confidence, nextAction, safety, owner route, escalation packet, and measurable validation. Use nextAction; do not introduce an incompatible action property.

04

Command metadata

Document purpose, command text or reference, expected signals, required access, safety classification, stop conditions, and whether execution occurs outside OGO. Never embed secrets or destructive defaults.