Docs Guard

Kontrollerar dokumentation mot källa: hallucinerade symboler, trasiga exempel, overifierbara påståenden

Testad · Fungerar ★ 9.2/10

Vad den gör

Docs Guard är en granskningsfärdighet för utvecklardokumentation — READMEs, API-referenser, docstrings, PHPDoc/JSDoc, changelogs, tutorials. Den omvandlar ett dokument till en lista med påståenden och verifierar varje symbol, signatur, flagga, endpoint, konfigurationsnyckel och kodexempel mot den faktiska källan, rapporterar sedan fynd som Påstående / Verklighet / Fix med fil:rad-bevis och ett publiceringsutlåtande. Utlöses när du ber att granska, granska eller faktagranska dokument, när en agent just har skrivit eller redigerat dokumentation, eller innan du publicerar en README eller API-referens.

Testrapport

INSTALL: frontmatter är giltig YAML med name + en lång, välavgränsad beskrivning; alla sex refererade filer (references/verification.md, code-samples.md, docstrings.md, review-checklist.md, sources.md, agents/openai.yaml) returnerade HTTP 200 vid rå hämtning; inga skript, ingen curl|sh, ingen base64, ingen hemlig åtkomst, ingen injektionstext — färdigheten är ren markdown. TRIGGER, 5/5 korrekt: SKA utlösas — "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" (beskrivningen nämner "write a README" och definierar ett live-läge); SKA INTE utlösas — "Rewrite our homepage hero copy to be more persuasive" (marknadsföringstext finns i den explicita DO NOT USE-listan), "Review this PR's Python error handling" (produktionskodgranskning, dirigeras till clean-code-guard). OUTPUT: Jag skrev en 24-raders retry.py plus en medvetet avvikande README, producerade en baslinjegranskning utan att någon färdighet laddades (8 fynd, prosalista, inga radreferenser), sedan en färdighetsföljande granskningsläge-pass; färdighetsversionen hittade 11 fynd inklusive tre som baslinjen missade (inga felvägsdokument så RetryError nämns aldrig, ingen versions-/kompatibilitetspolicy, exemplets odefinierade `fetch` som bryter självständigheten), citerade fil:rad på både dokument- och kodsidor, och — enligt verification.md:s "prefer executable checks" — körde jag faktiskt exemplet och fick `TypeError: retry() got an unexpected keyword argument 'max_retries'` och bekräftade `e.__cause__ is None`, vilket förvandlade två mjuka påståenden till hårda bevis. Kostnaden är längd (~3x baslinjen) och en självbedömd "23 claims checked"-räkning; de centrala avvikelsefynden överlappade kraftigt, så vinsten är rigor och bevis snarare än en ny klass av fångst. DOCS: README:s per-färdighets-påståenden (progressive-disclosure-referenser, @param-matchning, "blazingly fast leaves the building") mappas alla till verkliga regler i brödtexten — Regel 7 listar bokstavligen den frasen och docstrings.md täcker taggnoggrannhet; forskningssiffror citeras med URL:er i sources.md, som jag inte öppnade.

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

Kommandon och exempelprompter

/docs-guardKontrollerar dokumentation mot källa: hallucinerade symboler, trasiga exempel, overifierbara påståenden

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

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

Läs hela rapporten →