Docs Guard

Vérifie la documentation par rapport à la source : symboles hallucinés, exemples cassés, affirmations invérifiables

par amElnagdy · amElnagdy/guard-skills

Testé · Fonctionne ★ 9.2/10

Docs Guard — Vérifie la documentation par rapport à la source : symboles hallucinés, exemples cassés, affirmations invérifiables

Ce que fait

Docs Guard est une passe de révision pour la documentation développeur — READMEs, références API, docstrings, PHPDoc/JSDoc, changelogs, tutoriels. Il transforme un document en une liste d'affirmations et vérifie chaque symbole, signature, flag, endpoint, clé de configuration et exemple de code par rapport à la source réelle, puis rapporte les résultats sous forme de Claim / Reality / Fix avec des preuves fichier:ligne et un verdict de publication. Se déclenche lorsque vous demandez de réviser, auditer ou vérifier des documents, lorsqu'un agent vient d'écrire ou d'éditer de la documentation, ou avant de publier un README ou une référence API.

Rapport de test

INSTALL : le frontmatter est un YAML valide avec name + une longue description bien délimitée ; les six fichiers référencés (references/verification.md, code-samples.md, docstrings.md, review-checklist.md, sources.md, agents/openai.yaml) ont renvoyé HTTP 200 lors de la récupération brute ; pas de scripts, pas de curl|sh, pas de base64, pas d'accès secret, pas de texte d'injection — la compétence est purement markdown. DÉCLENCHEMENT, 5/5 correct : DEVRAIT se déclencher — "Révise ce README par rapport au code avant que je ne le publie, y a-t-il quelque chose de faux ?", "L'agent vient de réécrire notre référence API et nos docstrings, vérifie les dérives avant que je ne fusionne", "Écris un README pour ce paquet" (la description nomme "écrire un README" et définit un mode en direct) ; NE DEVRAIT PAS se déclencher — "Réécris le texte d'accroche de notre page d'accueil pour être plus persuasif" (le texte marketing est dans la liste explicite À NE PAS UTILISER), "Révise la gestion des erreurs Python de cette PR" (révision de code de production, routée vers clean-code-guard). SORTIE : j'ai écrit un retry.py de 24 lignes plus un README délibérément décalé, produit une révision de base sans compétence chargée (8 découvertes, liste en prose, pas de références de ligne), puis une passe en mode révision suivant la compétence ; la version de la compétence a trouvé 11 découvertes, dont trois que la base de référence avait manquées (pas de docs de chemin d'échec donc RetryError n'est jamais mentionnée, pas de politique de version/compatibilité, le `fetch` indéfini de l'exemple brisant l'auto-contenance), a cité fichier:ligne des deux côtés doc et code, et — suivant les "prefer executable checks" de verification.md — j'ai réellement exécuté l'exemple et obtenu `TypeError: retry() got an unexpected keyword argument 'max_retries'` et confirmé `e.__cause__ is None`, transformant deux assertions faibles en preuves solides. Le coût est la longueur (~3x la base de référence) et un décompte auto-évalué de "23 affirmations vérifiées" ; les principales découvertes de dérive se chevauchaient fortement, donc le gain est la rigueur et la preuve plutôt qu'une nouvelle classe de capture. DOCS : les affirmations par compétence du README (références à divulgation progressive, correspondance @param, "blazingly fast leaves the building") correspondent toutes à des règles réelles dans le corps — la Règle 7 liste littéralement cette phrase et docstrings.md couvre la précision des tags ; les chiffres de recherche sont cités avec des URL dans sources.md, que je n'ai pas ouvert.

Testé le: 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."

Commandes et exemples de prompts

  • /docs-guardVérifie la documentation par rapport à la source : symboles hallucinés, exemples cassés, affirmations invérifiables

Les skills se déclenchent sur des demandes en langage courant — aucune commande à retenir. Après installation, des prompts comme ceux-ci l'activent (en anglais) :

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