Skip to content

Document It

Document what changed — surgically by default; use DocSlime structures/methods when product-altitude truth is actually in play.

After a fix, refactor, or ship: update the nearest accurate home (README, runbook, API note, or an existing DocSlime section) so the next person can use the change. Escalate to DocSlime init/fill/ADR only when durable product/requirements/testing/decision docs are the real gap — not because you documented a PR.

Accuracy beats volume (Diátaxis, Write the Docs). KISS / Gall: don’t scaffold a docs org for a paragraph. When product contracts matter, DocSlime is the house quality trace. Lying or missing claims are still bugs — fix the claim you broke; don’t boil the ocean.

Right after work that invalidates docs; when onboarding/ops/API notes drift; when the user asks for product-docs altitude. Prefer issues document / pulls document for link stubs only.

  • Surgical update first (nearest existing home)
  • If docs/ already exists and the change hits a contract there, patch that file — skip fill theater
  • Use DocSlime init/add/fill/ADR only when earned
  • One write owner; verify commands/paths
  • docslime init as a side effect of “document this fix”
  • Duplicate PRODUCT/REQUIREMENTS into README
  • Keep empty theater templates
  • Spawn overlapping agents to “go faster”

13-quality-trace, 03-smallest-next-step, 04-evidence-over-vibes, 12-bugs-and-debt, Discover — spec altitude, Retire — archive

See also the handbook Sources & grounding bibliography.

document-it · docslime-* when product altitude is earned