Docs Guard

Kontrollerer dokumentation mod kilde: hallucinerende symboler, ødelagte eksempler, uverificerbare påstande

Testet · Virker ★ 9.2/10

Hvad det gør

Docs Guard er en gennemgangspass for udviklerdokumentation — READMEs, API-referencer, docstrings, PHPDoc/JSDoc, changelogs, tutorials. Den omdanner et dokument til en liste over påstande og verificerer hvert symbol, signatur, flag, endpoint, konfigurationsnøgle og kodeeksempel mod den faktiske kilde, og rapporterer derefter fund som Påstand / Virkelighed / Rettelse med fil:linje-bevis og en publiceringsdom. Udløses, når du beder om at gennemgå, auditere eller faktatjekke dokumentation, når en agent lige har skrevet eller redigeret dokumentation, eller før publicering af en README eller API-reference.

Testrapport

INSTALL: frontmatter er gyldig YAML med name + en lang, velafgrænset beskrivelse; alle seks refererede filer (references/verification.md, code-samples.md, docstrings.md, review-checklist.md, sources.md, agents/openai.yaml) returnerede HTTP 200 ved rå hentning; ingen scripts, ingen curl|sh, ingen base64, ingen hemmelig adgang, ingen injektionstekst — skill'en er ren markdown. TRIGGER, 5/5 korrekt: SKAL udløses — "Review this README against the code before I publish it, is anything in it wrong?", "The agent just rewrote our API reference and docstrings, check them for drift before I merge", "Write a README for this package" (beskrivelsen nævner "write a README" og definerer en live-tilstand); SKAL IKKE udløses — "Rewrite our homepage hero copy to be more persuasive" (marketingtekst er på den eksplicitte DO NOT USE-liste), "Review this PR's Python error handling" (produktionskode-gennemgang, routet til clean-code-guard). OUTPUT: Jeg skrev en 24-linjers retry.py plus en bevidst afvigende README, producerede en baseline-gennemgang uden skill indlæst (8 fund, prosa-liste, ingen linjereferencer), derefter en skill-følgende review-mode-pass; skill-versionen fandt 11 fund, herunder tre, baseline missede (ingen fejl-sti-dokumentation, so RetryError is never mentioned, no version/compat policy, the sample's undefined `fetch` breaking self-containment), citerede fil:linje på både dok- og kodesiden, og — following verification.md's "prefer executable checks" — jeg kørte faktisk eksemplet og fik `TypeError: retry() got an unexpected keyword argument 'max_retries'` og bekræftede `e.__cause__ is None`, hvilket omdannede to bløde påstande til hårde beviser. Omkostningen er længde (~3x baseline) og en selvvurderet "23 claims checked" optælling; de centrale drift-fund overlappede kraftigt, so the gain is rigor and evidence rather than a new class of catch. DOCS: README's per-skill-påstande (progressive-disclosure references, @param matching, "blazingly fast leaves the building") all map to real rules in the body — Rule 7 literally lists that phrase and docstrings.md covers tag accuracy; research figures are cited with URLs in sources.md, which I did not open.

Testet: 2026-07-21 · Claude Code 2.x (agent harness)

Installation

npx skills add amElnagdy/guard-skills --skill docs-guard        # add --global for a global install, --agent claude-code to pin the agent
# manual alternative:
git clone https://github.com/amElnagdy/guard-skills /tmp/guard-skills
mkdir -p ~/.claude/skills
cp -r /tmp/guard-skills/skills/docs-guard ~/.claude/skills/docs-guard
# then: "Use docs-guard on this README before we ship it."

Kommandoer og eksempelprompter

/docs-guardKontrollerer dokumentation mod kilde: hallucinerende symboler, ødelagte eksempler, uverificerbare påstande

Skills udløses af almindelige forespørgsler — ingen kommandoer at huske. Efter installationen aktiverer prompter som disse skillen (på engelsk):

Is this documentation accurate to the code
Review the docs before I publish this update
Check this README for stale information

Læs hele rapporten →