Skills Guide

Audit de Documentation

VérifiéSûr

Audite toute la documentation du projet en la comparant au code source réel. Vérifie les variables d'environnement, chemins, configurations Docker et descriptions de fonctionnalités, puis identifie les écarts et applique les correctifs.

Télécharger et utiliser
Spar Skills Guide Bot
DocumentationIntermédiaire
02/06/2026
Claude Code
#documentation-audit#code-cross-reference#accuracy-check#gap-analysis

Recommandé pour

Claude CodeDocumentation automatique

Synthèse automatique

Audite la documentation du projet pour en vérifier l'exactitude et l'exhaustivité en la recoupant avec le code source.

Points forts

  • Détecte les documentations obsolètes
  • Identifie les lacunes documentaires
  • Vérifie que les variables d'environnement correspondent au schéma
  • Confirme que les chemins de fichiers existent

Limites

  • Nécessite que la documentation existe dans un format reconnu
  • Peut manquer des documentations implicites en dehors des fichiers
  • Ne peut vérifier la correction logique des descriptions
Quand l'utiliser

Lorsque vous devez vous assurer que la documentation du projet est à jour et cohérente avec le code avant une version ou une transmission.

Quand l'éviter

Lorsque la documentation est intentionnellement minimale ou que votre projet est en début de développement sans code stable.

Analyse de sécurité

Sûr
Score qualité90/100

The skill only reads documentation and code to audit and fix documentation using the Edit tool. It does not execute external commands, exfiltrate data, or perform destructive actions. The operations are confined to improving documentation accuracy.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Full documentation audit
Run a documentation audit on this project: check README.md, CLAUDE.md, .env.example, and all SKILL.md files against the codebase. Report stale items, missing items, and apply fixes.
Check environment variable docs
Verify that all environment variables mentioned in the documentation match the keys in scripts/config_schema.py's ENV_MAP. Fix any discrepancies.
Find undocumented features
Scan the codebase for features that are not covered in any documentation file and list them as missing items.

Documentation Audit

Audit all project documentation for accuracy and completeness, cross-referencing against the actual codebase.

Usage

/documentation

Instructions

Step 1: Inventory

List all documentation files in the project:

  • README.md
  • CLAUDE.md
  • .env.example
  • All SKILL.md files under .claude/skills/
  • Significant inline documentation (Python docstrings, shell script comments)

Use Glob and Read tools to locate and read each file.

Step 2: Cross-Reference Code

For each documentation file, verify the following against the actual codebase:

  • Environment variables — All environment variable names mentioned must match keys in scripts/config_schema.py's ENV_MAP and ALIASES. Use Grep and Read to check.
  • File paths and directories — All file paths, directory references, and command examples must actually exist and work. Use Glob to verify paths.
  • Build arguments and Docker config — All build arguments, Docker image names, and port numbers must match Dockerfile and docker-compose.yml. Use Read to compare.
  • Feature descriptions — Feature descriptions must match actual code behavior. Read the relevant source code to verify.

Step 3: Identify Gaps

Check for:

  • Features present in code but missing from documentation.
  • Deprecated or removed features still mentioned in documentation.
  • Inconsistencies between different documentation files (e.g., README.md says one thing, .env.example says another).

Step 4: Report and Fix

Produce a summary of findings organized as:

  • Accurate items — Documentation that correctly reflects the codebase.
  • Stale items — Documentation that references removed or changed features.
  • Missing items — Features or configuration present in code but not documented.

Apply fixes directly to the documentation files using the Edit tool. For each fix, explain what was changed and why.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/documentation-audit-mm78noeb/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/documentation-audit-mm78noeb' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-audit-mm78noeb/download' --output '.skill-downloads/documentation-audit-mm78noeb/SKILL.md.part' && mv '.skill-downloads/documentation-audit-mm78noeb/SKILL.md.part' '.skill-downloads/documentation-audit-mm78noeb/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Le fichier ne fournit pas un en-tête name/description exploitable pour cette procédure native. Le téléchargement reste disponible pour lecture ; utilisez le mode manuel ci-dessous.

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/documentation-audit-mm78noeb/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires

Rédaction de docs Supabase

Documentation

Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.

Claude CodeintermediateSûr 108,544
Skills Guide Bot

Créer un enregistrement de décision d'architecture

Documentation

Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.

Claude CodeintermediateSûr 69,659
Skills Guide Bot

Mise à jour de plan avec recherche approfondie

Documentation

Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.

Claude CodeadvancedSûr 248,015
Skills Guide Bot