Give every doc an owner and a review date

How to do it

Put owner and reviewed in each doc's front matter. List the docs folders in the code owners file, so the owner reviews changes. A scheduled job opens a ticket for the owner when a doc passes 6 months. Reviewing means reading it, fixing it and updating the date. Delete docs nobody owns. Runbooks need this most, as Write the restore runbook says. Policies follow Keep every policy short and owned.

Examples

JavaScript example

const MAX_AGE_DAYS = 183;
const DAY_MS = 86_400_000;

export const isDocStale = (frontMatter, today) =>
  !frontMatter.owner || (today - new Date(frontMatter.reviewed)) / DAY_MS > MAX_AGE_DAYS;

Python example

from datetime import date

MAX_AGE_DAYS = 183

def is_doc_stale(front_matter: dict, today: date) -> bool:
    reviewed = date.fromisoformat(front_matter.get("reviewed", "1970-01-01"))
    return not front_matter.get("owner") or (today - reviewed).days > MAX_AGE_DAYS

How to check

A script reads the front matter of every doc. Each has an owner and a reviewed date under 6 months old, or an open ticket for it.

Related rules

• CMP-3 Give every duty one named owner in Compliance and governance
• CMP-37 Keep every policy short and owned in Compliance and governance
• DOC-31 Ask on every article whether it helped in Documentation
• OPS-47 Write the restore runbook in Operations and observability
• DOC-32 Show the last-updated date on every docs page in Documentation
• DOC-36 Delete docs nobody needs and redirect their address in Documentation
• SUP-23 Give every macro and article an owner and a review date in Customer support