Documentation helps people make decisions, repeat work, and understand context without relying only on meetings or private messages.
Write for the next reader
Assume the reader is capable but missing context. Explain the purpose of the page, define uncommon terms, and link to related material.
Keep structure predictable
Use sentence casing for headings. Prefer clear sections such as purpose, scope, steps, owner, and related pages. Long pages should include a table of contents.
Use tables when comparison helps
Tables are useful for service directories, roles and responsibilities, decision options, and checklists with owners. Avoid tables for paragraphs that would be easier to read as normal text.
Review cadence
| Page type | Suggested review cadence | Owner |
|---|---|---|
| Policy summary | Quarterly | Policy owner |
| Process guide | Every six months | Process owner |
| Team overview | Quarterly | Team lead |
| FAQ | Monthly | Page maintainer |
Page ownership
Every operational page should have an owner or owning team. The owner does not need to write every update, but they should make sure the page remains accurate.
