Docs Guard

Controleert docs tegen bron: gehallucineerde symbolen, kapotte voorbeelden, onverifieerbare claims

Getest · Werkt ★ 9.2/10

Wat het doet

Docs Guard is een review-pass voor ontwikkelaarsdocumentatie — README's, API-referenties, docstrings, PHPDoc/JSDoc, changelogs, tutorials. Het zet een document om in een lijst van claims en verifieert elk symbool, handtekening, vlag, endpoint, config-sleutel en codevoorbeeld tegen de daadwerkelijke bron, en rapporteert vervolgens bevindingen als Claim / Reality / Fix met file:line bewijs en een publicatie-oordeel. Activeert wanneer u vraagt om docs te reviewen, auditen of fact-checken, wanneer een agent zojuist documentatie heeft geschreven of bewerkt, of vóór het publiceren van een README of API-referentie.

Testrapport

INSTALL: frontmatter is geldige YAML met name + een lange, goed afgebakende description; alle zes de genoemde bestanden (references/verification.md, code-samples.md, docstrings.md, review-checklist.md, sources.md, agents/openai.yaml) retourneerden HTTP 200 bij ruwe fetch; geen scripts, geen curl|sh, geen base64, geen geheime toegang, geen injectietekst — de skill is pure markdown. TRIGGER, 5/5 correct: MOET activeren — "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" (de beschrijving noemt "write a README" en definieert een live-modus); MOET NIET activeren — "Rewrite our homepage hero copy to be more persuasive" (marketingtekst staat in de expliciete DO NOT USE-lijst), "Review this PR's Python error handling" (productiecode-review, gerouteerd naar clean-code-guard). OUTPUT: Ik schreef een 24-regelige retry.py plus een opzettelijk afgedreven README, produceerde een baseline-review zonder geladen skill (8 bevindingen, proza-lijst, geen regelreferenties), daarna een skill-gevolgde review-modus pass; de skill-versie vond 11 bevindingen inclusief drie die de baseline miste (geen failure-path docs dus RetryError wordt nooit genoemd, geen versie/compatibiliteitsbeleid, de ongedefinieerde `fetch` van het voorbeeld die zelfstandigheid verbreekt), citeerde file:line aan zowel doc- als codekant, en — volgens verification.md's "prefer executable checks" — ik voerde het voorbeeld daadwerkelijk uit en kreeg `TypeError: retry() got an unexpected keyword argument 'max_retries'` en bevestigde `e.__cause__ is None`, waardoor twee zachte beweringen hard bewijs werden. Kosten zijn lengte (~3x de baseline) en een zelf-ingeschatte "23 claims checked" telling; de kernafwijkingen overlapten zwaar, dus de winst is rigor en bewijs in plaats van een nieuwe klasse van vangst. DOCS: README's per-skill claims (progressive-disclosure references, @param matching, "blazingly fast leaves the building") komen allemaal overeen met echte regels in de body — Regel 7 vermeldt letterlijk die zin en docstrings.md behandelt tag-nauwkeurigheid; onderzoeksgegevens worden geciteerd met URL's in sources.md, die ik niet heb geopend.

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

Installatie

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

Commando's en voorbeeldprompts

/docs-guardControleert docs tegen bron: gehallucineerde symbolen, kapotte voorbeelden, onverifieerbare claims

Skills reageren op gewone verzoeken — geen commando's om te onthouden. Na installatie activeren prompts zoals deze de skill (in het Engels):

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

Volledig rapport (Engels) →