Docs & Code Guide

Documentation review cadence: verify and stamp, at a rhythm set by the doc type

A documentation review is a verification pass, not a rewrite: open the page, check the claims you can test, fix small lies on the spot, file a ticket for structural ones, and update the last-verified stamp. Done that way it costs minutes per page, which is what makes a cadence sustainable. The cadence itself varies by doc type: runbooks every 30 days or after each use, architecture pages every 90, onboarding guides every 180, ADRs never, because they are immutable records.

6 min readFor teams whose review process is an annual guilt spike

See it as a diagram

Everything below, as a diagram you can edit. Describe yours and see it in seconds.

142/20003 credits left
Try:

No account needed · Editable canvas, not a picture

Review means verify and stamp

The reason review schedules die is that teams define review as improve, and improving a page takes an hour nobody has. Define it as verify instead: confirm the commands still run, the service names still exist, the diagram still matches production, the links still resolve. Fix anything fixable in under five minutes inline. Anything bigger becomes a ticket, and if the page is mostly wrong, the honest outcomes are a rewrite ticket or archival, not a polite pass.

Then stamp it: a last-verified date and the verifier's name, distinct from last-edited. The stamp is the entire output of a passing review, and it is the datum every freshness dashboard and documentation SLA runs on. A review that ends without a stamp update did not happen, as far as the tooling can tell.

Cadence by doc type

One cadence for all docs fails in both directions: runbooks rot in a quarter while ADRs never need review at all. Set the cadence per class and write it down; the table below is a defensible starting point that a docs freshness policy can adopt wholesale.

Generated documents earn the lightest treatment: an API reference built from source in CI needs no calendar review, only a regeneration hook on release. Generated architecture diagrams shift the review from redraw to glance-and-confirm, which is most of why cheap regeneration changes the cadence math, as covered in how often architecture diagrams should be updated.

Doc type            Calendar floor   Event trigger
Runbooks            30 days          after every incident that used one
Service overviews   90 days          major change merged to the service
Architecture pages  90 days          service added/removed, dependency
                                     changed, datastore swapped
Onboarding guides   180 days         each new-hire cohort finishes
ADRs                none             immutable: supersede, never edit
Generated refs      none             regenerate on release

Event triggers versus the calendar floor

Events should trigger most reviews, because events know which page went stale: the incident that used a runbook is the best possible reviewer of that runbook, and the merge that split a service is the moment its overview needs eyes. The calendar exists as a floor underneath the triggers, catching the pages whose events nobody fired. A page reviewed only by calendar is a page whose triggers are miswired, which is worth noticing in itself.

The floor also bounds the damage of a silent failure: with a 90-day floor, the worst case for a missed trigger is one quarter of drift rather than three years of it.

Who reviews, and where it fits the sprint

The document owner reviews, because verification requires knowing what true looks like. Two placements make it stick without a standing meeting: on-call reviews every runbook they actually opened during their rotation, stamping as they go, and each engineer picks one page from the stale queue per sprint, a task sized in minutes that survives sprint pressure precisely because it is small.

A team of six with 40 owned pages on the table above averages roughly 15 reviews a month, or two to three short checks per person. That is the entire cost of a wiki that stays credible, and the annual all-hands docs cleanup week disappears in exchange.

The protocol on one line

Open the page, test its claims, fix the five-minute lies, ticket the rest, update the last-verified stamp. Minutes per page, on the cadence its doc type sets.

FAQ

How often should documentation be reviewed?

By doc type: runbooks every 30 days or immediately after an incident uses one, service overviews and architecture pages every 90 days, onboarding guides every 180 days. ADRs are immutable and never reviewed, and generated references need regeneration hooks, not calendar reviews. Event triggers should drive most reviews, with the calendar as the floor that catches missed events.

What does a documentation review actually involve?

Verification, not rewriting: test the claims on the page (commands run, names exist, links resolve, the diagram matches production), fix anything that takes under five minutes inline, file tickets for structural problems, and update the last-verified stamp with a date and name. A review that would take more than about ten minutes signals the page is too big or too stale for the protocol.

How long should a documentation review take?

Minutes per page, typically five to ten. The review is a spot check against reality plus a stamp update, not an editing session. Reviews that routinely take an hour mean the definition has drifted from verify to improve, which is the main reason review cadences collapse.

Who should review documentation?

The document owner, because verifying claims requires knowing the system. Two placements work well in practice: on-call engineers stamp every runbook they opened during their rotation, and each team member takes one page from the stale queue per sprint. Spread this way, a 40-page surface costs each person two or three short checks a month.

What if a review finds the page is completely wrong?

Do not stamp it. A page that is mostly wrong gets one of two outcomes: a rewrite ticket with the page banner-marked as under revision, or archival if nothing still depends on it. Stamping a wrong page is worse than skipping the review, because the stamp tells the next reader the lies were recently confirmed.