Files
archie/docs/prds/RULES.md
T
sam 71d7da219a docs(prds): define three PRD statuses and approve the control plane
PRD headers carry 26 distinct status strings across docs/prds/. Draft,
Approved and Finalised are the only three, and a finalised PRD is superseded
rather than edited.

runtime-control-plane.md still read "Draft -- not approved" after it was
approved to proceed.
2026-09-21 10:43:08 +10:00

1.8 KiB

PRD writing rules

These rules apply to every file in docs/prds/.

  • Search existing PRDs, issues, architecture records, and code first. Do not ask the maintainer to repeat recorded requirements.
  • A newer maintainer decision overrides an older design. Mark the old design as superseded instead of preserving or defending it.
  • Write plain English. Use a technical term only when the reader needs that exact contract or concept.
  • Use the shortest direct sentence. Write “When upgraded, existing instances are migrated to the database,” not a description of an importer seeding absent resources.
  • State each fact once. Do not repeat a heading, summarize a list before showing it, or restate a decision afterward.
  • Every sentence must add a decision, requirement, constraint, evidence, or verification step. Delete narration and explanations of obvious text.
  • Do not turn a requested outcome into extra product features. Keep inferences open until the maintainer or repository evidence settles them.
  • Do not create a process for a logical boundary. Add one only when it must deploy, scale, start, secure, or fail separately.
  • Describe working behavior, not explanatory UI around missing behavior. State what users can do and how success is proved.
  • Before approval, use independent read-only reviewers to check a cross-cutting PRD for missing behavior and exaggerated claims. Verify and synthesize their findings; do not copy their prose.
  • Before requesting approval, review every sentence for complexity, repetition, and unsupported scope.
  • Every PRD carries one of three statuses. Draft until the maintainer explicitly approves it, Approved once they have and while the work is being built, Finalised when the work is complete. A finalised PRD does not change; supersede it with a new one instead.