Docs Guard

Kontroluje dokumentaci proti zdroji: halucinované symboly, rozbité ukázky, neověřitelná tvrzení

Otestováno · Funguje ★ 9.2/10

Co umí

Docs Guard je revizní průchod pro vývojářskou dokumentaci — README, API reference, docstringy, PHPDoc/JSDoc, changelogy, tutoriály. Přemění dokument na seznam tvrzení a ověří každý symbol, signaturu, flag, endpoint, konfigurační klíč a ukázku kódu proti skutečnému zdroji, poté hlásí zjištění jako Tvrzení / Realita / Oprava s důkazem file:line a verdiktem o publikaci. Spouští se, když požádáte o revizi, audit nebo ověření faktů v dokumentaci, když agent právě napsal nebo upravil dokumentaci, nebo před publikováním README nebo API reference.

Testovací report

INSTALACE: frontmatter je platný YAML s name + dlouhým, dobře vymezeným popisem; všech šest odkazovaných souborů (references/verification.md, code-samples.md, docstrings.md, review-checklist.md, sources.md, agents/openai.yaml) vrátilo HTTP 200 při raw načtení; žádné skripty, žádné curl|sh, žádné base64, žádný tajný přístup, žádný injekční text — dovednost je čistý markdown. SPUŠTĚNÍ, 5/5 správně: MĚLO by se spustit — "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" (popis jmenuje "write a README" a definuje živý režim); NEMĚLO by se spustit — "Rewrite our homepage hero copy to be more persuasive" (marketingový text je v explicitním seznamu DO NOT USE), "Review this PR's Python error handling" (revize produkčního kódu, směrováno na clean-code-guard). VÝSTUP: Napsal jsem 24řádkový retry.py plus záměrně posunutý README, vytvořil základní recenzi bez načtené dovednosti (8 zjištění, seznam v próze, žádné odkazy na řádky), poté průchod v režimu recenze podle dovednosti; verze dovednosti našla 11 zjištění včetně tří, které základ minul (žádná dokumentace cesty selhání, takže RetryError není nikdy zmíněna, žádná verze/kompatibilní politika, nedefinovaný `fetch` v ukázce narušující soběstačnost), citovala file:line na obou stranách dokumentace a kódu, a — podle "prefer executable checks" z verification.md — jsem skutečně spustil ukázku a dostal `TypeError: retry() got an unexpected keyword argument 'max_retries'` a potvrdil `e.__cause__ is None`, čímž se dvě měkká tvrzení změnila na tvrdé důkazy. Náklady jsou délka (~3x základ) a vlastní hodnocení "23 claims checked"; hlavní zjištění posunu se silně překrývala, takže zisk je v přísnosti a důkazech spíše než v nové třídě zachycení. DOKUMENTACE: Tvrzení README pro jednotlivé dovednosti (progresivní odhalování referencí, @param matching, "blazingly fast leaves the building") se všechna mapují na skutečná pravidla v těle — Pravidlo 7 doslova uvádí tuto frázi a docstrings.md pokrývá přesnost tagů; výzkumné údaje jsou citovány s URL v sources.md, které jsem neotevřel.

Testováno: 2026-07-21 · Claude Code 2.x (agent harness)

Instalace

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

Příkazy a ukázkové prompty

/docs-guardKontroluje dokumentaci proti zdroji: halucinované symboly, rozbité ukázky, neověřitelná tvrzení

Skilly se spouštějí běžnými požadavky — žádné příkazy k zapamatování. Po instalaci ho aktivují prompty jako tyto (anglicky):

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

Kompletní testovací report (anglicky) →