Files
playbook/antigravity-awesome-skills/skills/docs-guard/references/verification.md
T
2026-07-18 00:02:59 +00:00

3.0 KiB

Docs Guard — Verification Procedure

The mechanical heart of this skill: turn a document into a list of claims, then check each claim against the source of truth.

Contents

  • Step 1: Extract the claims
  • Step 2: Verify each claim type
  • Step 3: Record what you verified
  • When you cannot verify

Step 1: Extract the claims

Scan the doc and list every:

  • Function, method, class, constant, hook, event name
  • CLI command, subcommand, flag, default value
  • HTTP endpoint, method, status code, request/response field
  • Config key, env var, file path, directory layout claim
  • Version number, compatibility statement, dependency requirement
  • Behavioral claim ("retries three times", "case-insensitive", "idempotent")

Inline code spans and code blocks are claim-dense; prose hides claims in verbs ("automatically reconnects" is a claim).

Step 2: Verify each claim type

Claim type Source of truth How
Symbol exists The codebase Grep definition (function name, class Name, def name, export) — not usages, the definition
Signature The definition site Read parameters, defaults, return; compare name-by-name with the doc
CLI flag The argument parser source, or --help output if runnable Read the parser registration; flags in README but not in the parser are hallucinations
Endpoint Route registration (router file, register_rest_route, annotations) Match path, method, and handler
Config key The code that reads it (getenv, config schema, get_option) A documented key nothing reads is dead documentation
Default value The definition, not the docs of the definition Defaults drift silently; read the current line
Version claim Changelog, git tags, dependency manifests "Since 2.3" must appear in the 2.3 changelog or tag diff
Behavioral claim The implementation path Read the function; trace the claimed behavior (retry loop, case fold, guard clause)
Internal link/anchor The target file/heading Resolve the relative path; slugify the heading and compare

Step 3: Record what you verified

In write-time mode, keep a short verification trail in your working notes (not in the doc): claim → file:line where confirmed. In review mode, this trail becomes your evidence — every finding cites the definition site that contradicts the doc.

When the runtime allows execution, prefer executable checks: run --help, run the sample, run a link checker. When it does not, source-reading is the standard — never skip to "it looks right."

When you cannot verify

If the source of truth is unavailable (private dependency, external service, missing schema):

  1. Say so explicitly rather than guessing.
  2. Downgrade the claim to what you can verify ("the client calls the /v2/orders endpoint" → verified in client code, even if the server is unreachable).
  3. Never decorate an unverified claim with confident language. "Should", "appears to", or a direct question to the user beats a fluent hallucination.