Skip to main content

Documentation Expectations

Status: 🚧 Stub

What engineers are expected to document, where that documentation lives, and how we keep it from going stale.

Topics to cover​

  • What lives in this engineering guide vs. what lives in a project's README
  • Required project README contents (setup, deploy, gotchas, key contacts)
  • Inline code documentation (PHPDoc, JSDoc) expectations
  • Architectural decision records (ADRs) — when to write one
  • Changelog conventions
  • Documenting third-party integrations
  • Keeping client-facing docs (e.g., editor handoffs) separate from internal docs

Owner: TBD | Last reviewed: TBD