Files
flying-jib/agent/ADRs/0010-documentation-as-code.md
T
2026-07-30 23:02:00 -04:00

824 B

ADR-0010: Documentation as code

  • Status: Accepted
  • Date: 2026-07-30

Context

Long-lived multi-agent development drifts when docs lag. The project requires three audience-specific trees plus agent governance from day one.

Decision

Maintain from the first commit:

  • living_docs/ — current truth
  • developer_docs/ — contributor technical docs
  • user_docs/ — end-user docs
  • agent/ — rules, workflow, ADRs, security

Policy: same PR as code; session incomplete without living_docs updates. See agent/DOCUMENTATION_POLICY.md.

Consequences

Positive

  • Continuous onboarding
  • ADRs + living status reduce rework

Negative / tradeoffs

  • Doc volume to maintain
  • Discipline required from AI agents

Follow-ups

  • Phase 0 scaffold
  • Enforce via PR checklist / review