Docs Guard

Sjekker dokumenter mot kilde: hallusinerte symboler, ødelagte eksempler, uverifiserbare påstander

Bestått ★ 9.2/10

Hva den gjør

Docs Guard er en gjennomgangsferdighet for utviklerdokumentasjon — READMEs, API-referanser, docstrings, PHPDoc/JSDoc, endringslogger, veiledninger. Den gjør et dokument om til en liste over påstander og verifiserer hvert symbol, signatur, flagg, endepunkt, konfigurasjonsnøkkel og kodeeksempel mot den faktiske kilden, og rapporterer deretter funn som Påstand / Virkelighet / Fiks med fil:linje-bevis og en publiseringsdom. Utløses når du ber om å gjennomgå, revidere eller faktasjekke dokumenter, når en agent nettopp har skrevet eller redigert dokumentasjon, eller før publisering av en README eller API-referanse.

Testrapport

INSTALL: frontmatter er gyldig YAML med name + en lang, velavgrenset beskrivelse; alle seks refererte filer (references/verification.md, code-samples.md, docstrings.md, review-checklist.md, sources.md, agents/openai.yaml) returnerte HTTP 200 ved rå henting; ingen skript, ingen curl|sh, ingen base64, ingen hemmelig tilgang, ingen injeksjonstekst — ferdigheten er ren markdown. TRIGGER, 5/5 korrekt: BØR utlø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 navngir "write a README" og definerer en live-modus); BØR IKKE utløses — "Rewrite our homepage hero copy to be more persuasive" (markedsføringstekst er i den eksplisitte DO NOT USE-listen), "Review this PR's Python error handling" (produksjonskodegjennomgang, rutet til clean-code-guard). OUTPUT: Jeg skrev en 24-linjers retry.py pluss en bevisst avvikende README, produserte en grunnlinjegjennomgang uten ferdighet lastet (8 funn, prosaliste, ingen linjereferanser), deretter en ferdighetsfulgt gjennomgangsmodus-pass; ferdighetsversjonen fant 11 funn inkludert tre grunnlinjen savnet (ingen feilsti-dokumenter så RetryError er aldri nevnt, ingen versjons-/kompatibilitetspolicy, eksempelets udefinerte `fetch` som bryter selvstendigheten), siterte fil:linje på både dokument- og kodesiden, og — etter verification.mds "prefer executable checks" — jeg kjørte faktisk eksempelet og fikk `TypeError: retry() got an unexpected keyword argument 'max_retries'` og bekreftet `e.__cause__ is None`, noe som gjorde to myke påstander til harde bevis. Kostnaden er lengde (~3x grunnlinjen) og en selvvurdert "23 claims checked"-telling; kjerneavviksfunnene overlappet sterkt, så gevinsten er strenghet og bevis snarere enn en ny klasse av fangst. DOKUMENTASJON: READMEs per-ferdighet-påstander (progressive-disclosure references, @param matching, "blazingly fast leaves the building") mapper alle til virkelige regler i kroppen — Regel 7 lister bokstavelig talt den frasen og docstrings.md dekker tag-nøyaktighet; forskningstall er sitert med URL-er i sources.md, som jeg ikke åpnet.

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

Installer

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-guardSjekker dokumenter mot kilde: hallusinerte symboler, ødelagte eksempler, uverifiserbare påstander

Skills utløses av vanlige forespørsler — ingen kommandoer å huske. Etter installasjonen 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

Full rapport →