Docs Guard
Controlla i documenti rispetto alla fonte: simboli allucinati, campioni rotti, affermazioni inverificabili
Promosso
Cosa fa
Docs Guard è un passaggio di revisione per la documentazione degli sviluppatori — README, riferimenti API, docstring, PHPDoc/JSDoc, changelog, tutorial. Trasforma un documento in un elenco di affermazioni e verifica ogni simbolo, firma, flag, endpoint, chiave di configurazione e campione di codice rispetto alla fonte effettiva, quindi riporta i risultati come Claim / Reality / Fix con prove file:linea e un verdetto di pubblicazione. Si attiva quando si chiede di rivedere, verificare o controllare i fatti dei documenti, quando un agente ha appena scritto o modificato la documentazione, o prima di pubblicare un README o un riferimento API.
Rapporto di test
INSTALL: il frontmatter è YAML valido con name + una descrizione lunga e ben definita; tutti e sei i file referenziati (references/verification.md, code-samples.md, docstrings.md, review-checklist.md, sources.md, agents/openai.yaml) hanno restituito HTTP 200 al recupero raw; nessuno script, nessun curl|sh, nessun base64, nessun accesso segreto, nessun testo di iniezione — la skill è puro markdown. TRIGGER, 5/5 corretto: DOVREBBE attivarsi — "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" (la descrizione nomina "write a README" e definisce una modalità live); NON DOVREBBE attivarsi — "Rewrite our homepage hero copy to be more persuasive" (il testo di marketing è nell'elenco esplicito DO NOT USE), "Review this PR's Python error handling" (revisione del codice di produzione, instradata a clean-code-guard). OUTPUT: ho scritto un retry.py di 24 righe più un README deliberatamente deviato, ho prodotto una revisione di base senza skill caricata (8 risultati, elenco in prosa, nessun riferimento di riga), quindi un passaggio di revisione seguendo la skill; la versione della skill ha trovato 11 risultati inclusi tre che la baseline aveva perso (nessuna documentazione del percorso di fallimento quindi RetryError non è mai menzionato, nessuna politica di versione/compatibilità, il `fetch` indefinito del campione che rompe l'auto-contenimento), ha citato file:linea sia sul documento che sul codice, e — seguendo "prefer executable checks" di verification.md — ho effettivamente eseguito il campione e ho ottenuto `TypeError: retry() got an unexpected keyword argument 'max_retries'` e ho confermato `e.__cause__ is None`, trasformando due asserzioni soft in prove concrete. Il costo è la lunghezza (~3x la baseline) e un conteggio auto-valutato di "23 claims checked"; i risultati principali della deviazione si sovrapponevano pesantemente, quindi il guadagno è rigore e prove piuttosto che una nuova classe di cattura. DOCS: le affermazioni per skill del README (riferimenti a divulgazione progressiva, corrispondenza @param, "blazingly fast leaves the building") mappano tutte a regole reali nel corpo — la Regola 7 elenca letteralmente quella frase e docstrings.md copre l'accuratezza dei tag; le cifre della ricerca sono citate con URL in sources.md, che non ho aperto.
Testato il: 2026-07-21 · Claude Code 2.x (agent harness)
Installazione
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."
Comandi e prompt di esempio
/docs-guardControlla i documenti rispetto alla fonte: simboli allucinati, campioni rotti, affermazioni inverificabili
Gli skill si attivano con richieste in linguaggio naturale, senza comandi da ricordare. Dopo l'installazione, prompt come questi lo attivano (in inglese):
Is this documentation accurate to the codeReview the docs before I publish this updateCheck this README for stale information