View as Markdown

Concepts

Tip

A document is a Markdown file with front matter. It has a type, an owner, a status and relations. Together the relations form a graph that spec check keeps honest.

Read in this order

  1. Document types — sot, adr, plan and eight more, and when to use each.
  2. Lifecycle — statuses, and why they only move forward.
  3. Owners and ids — where a document lives and how its id is made.
  4. The graph — relations, spec context and spec graph.
  5. Checks — rules, guards, plugins and audits.
  6. Times and tasks — timestamps, time zones and task items.