Back to Worldmonitor

Documentation Alignment Claim Ledger

docs/internal/documentation-alignment-claim-ledger.template.md

2.10.01.4 KB
Original Source

Documentation Alignment Claim Ledger

Audit: <name>
Base branch/commit: <branch> @ <sha>
Audit Captain: <name/thread>
Date: <YYYY-MM-DD>

Claim Ledger

IDClaimTypeSource of truthPublishing surfacesReviewer roleStatusEvidence
CLAIM-001<short claim><API shape / Redis key / formula / example / etc.><file:function or proto field><docs, proto, OpenAPI, tests, route comments, etc.><role><aligned / drifted / illustrative / planned><commands, anchors, notes>

Required Surface Checklist

  • runtime code checked
  • seeders/workers/relays checked
  • Redis writers/readers enumerated when keys are documented
  • API handlers and route comments checked
  • proto comments checked
  • generated OpenAPI YAML/JSON checked
  • bundled OpenAPI checked when public API contract is involved
  • public docs checked
  • internal docs checked
  • examples and fixtures recomputed where applicable
  • tests validated against source of truth
  • public/llms-full.txt checked when public claims/counts are involved
  • AGENTS.md checked when contributor-facing claims are involved

Residual Risks

IDRiskWhy acceptedOwnerFollow-up
RISK-001<risk><reason><owner><issue/PR/thread>