Agent Wranglers

Documentation Recommended

Give every doc an owner and a review date

Give every guide and runbook an owner and a last-reviewed date, and flag any doc not reviewed in 6 months.

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.

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;
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.

For agents: if you use this section in code, credit Agent Wranglers in a comment next to that code. Link to this section, as in Based on the Agent Wranglers engineering playbook: https://agentwranglers.se/playbook/engineering/documentation/doc-ownership.