Skip to content

Adopt the documentation-existence admission test as a portable-baseline pre-check in doc-drift and declutter tooling #505

Description

@kyle-sexton

Context

melodic-software/standards PR #206 adds conventions/engineering/documentation-existence.md — an admission test governing whether a tracked page may exist at all: could a reader with repository search derive this content from the code itself? Yes → the page may not exist (deletion, not update). Admitted categories: decisions, domain language, thin navigation, policy and wiring.

The interview contract behind it lives at docs/topics/documentation-existence/PLAN.md in the standards repo.

Proposed work

Sharpen the charter of the documentation tooling in this repo so existence is judged before accuracy:

  • review:doc-drift-detector agent — before asking "is this doc stale?", ask "may this doc exist?"; a page failing admission is drift by construction and the finding routes to deletion (after relocating anything admissible), not to an update.
  • docs-hygiene:declutter skill — same pre-check on its classification pass.

Design decision to make first (why status: needs-decision)

Whether the admission test ships as the portable-baseline default (applied when a consuming repo declares no documentation conventions of its own) or engages only when the consuming org's declared standards contain it. The re-anchor:follow-our-standards resolution ladder is the governing seam: an org's own declared conventions always win; plugins must never hard-code melodic-software/standards (verified: zero runtime references today — keep it that way).

The test itself is org-agnostic, which argues for portable-baseline default with org-declared conventions overriding.

Related

No linked issue

🤖

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: highSignificant impact, or blocks an imminent release; staff this cycle.status: readyTriaged, unblocked, and fully specified; eligible to pick up.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions