Skills Guide

Audit de documentation

VérifiéSûr

Auditer et mettre à jour les fichiers de documentation pour correspondre à l'état réel du dépôt.

Télécharger et utiliser
Spar Skills Guide Bot
DocumentationIntermédiaire
23/07/2026
Claude Code
#documentation#audit#repo-maintenance#makefile#github

Recommandé pour

Claude CodeDocumentation automatiqueAudit de sécuritéAutomatisation GitIngénieur sécurité

Synthèse automatique

Audite les fichiers de documentation d’un dépôt GitHub et les corrige pour qu’ils correspondent à l’état réel du code et des cibles make.

Points forts

  • Compare la documentation aux répertoires, aux fichiers tools/*.tl, aux Makefile/work.mk/reflect.mk et aux workflows GitHub Actions.
  • Limite strictement les modifications aux fichiers Markdown de la racine et de docs/.
  • Consigne chaque correction dans un commit avec un message descriptif.
  • Produit un rapport final avec les changements, le statut et les problèmes restants.

Limites

  • Suppose une structure de dépôt spécifique avec o/repo, skills/, tools/*.tl, Makefile, work.mk et reflect.mk.
  • Ne corrige pas le code, les makefiles ni les workflows, même si la documentation révèle une incohérence ailleurs.
  • Reste volontairement prudent et peut laisser de côté des inexactitudes incertaines.
Quand l'utiliser

Utilisez cette skill lorsqu’un dépôt contient déjà AGENTS.md et docs/ et que vous voulez vérifier rapidement que la documentation correspond aux fichiers, cibles make et workflows existants.

Quand l'éviter

Ne l’utilisez pas pour rédiger une nouvelle documentation spéculative ou pour auditer un dépôt sans les conventions de structure et de makefiles décrites par la skill.

Analyse de sécurité

Sûr
Score qualité85/100

The skill only audits and edits documentation files and commits those changes; it explicitly forbids modifying code, tool files, makefiles, or workflows, and contains no destructive, exfiltrating, obfuscated, or safety-disabling instructions.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Full docs audit
Audit AGENTS.md and docs/ in o/repo against the actual skills/ tools, Makefile, work.mk, reflect.mk, and .github/workflows. Fix any inaccuracies in the documentation files, commit each fix, and write o/docs/docs.md with the changes and status.
Check structure and make targets
Check whether the structure tree, tool lists, and make targets in docs/architecture.md and docs/work.md still match the repository. Update only the Markdown documentation files and report any remaining issues.
Conservative documentation sync
Review the docs in o/repo for outdated phase descriptions and setup permissions, but be conservative: only fix clear mismatches and do not add documentation for anything that does not already exist.

name: docs description: Audit and update documentation files to match actual repo state.

Docs

You are auditing documentation in a GitHub repository and fixing any inaccuracies.

Environment

  • The target repo is cloned at o/repo/. You have read and write access.
  • Only modify documentation files: AGENTS.md and files under docs/.

Instructions

  1. Read all documentation files: AGENTS.md, docs/architecture.md, docs/work.md, docs/reflect.md, docs/conventions.md, and any other .md files in docs/.
  2. Read the actual repo structure to compare against docs: a. List skills/ directories and their tools/*.tl files. b. Read Makefile for targets and help text. c. Read work.mk for work loop targets and standalone targets. d. Read reflect.mk for reflect loop targets. e. Read .github/workflows/ for workflow definitions.
  3. For each doc file, check:
    • structure tree: does the tree in AGENTS.md match actual directories, files, and tool lists?
    • usage examples: do make targets listed in usage sections actually exist?
    • tool lists: do parenthetical tool lists match actual .tl files in each skill's tools/ directory?
    • phase descriptions: do phase lists (e.g. fetch → analyze → publish) match the actual make targets?
    • permissions and setup: does setup info match current workflow files?
  4. Fix any inaccuracies by editing the doc files directly.
  5. Stage and commit each fix with a descriptive message.

Constraints

  • Only modify .md files in the repo root or docs/ directory.
  • Do not modify code, tool files, makefiles, or workflows.
  • Do not add speculative documentation — only document what exists.
  • Be conservative: if unsure whether something is wrong, leave it alone.

Output

Write o/docs/docs.md:

# Docs

## Changes
<list of files changed and what was fixed>

## Status
<success|no-changes>

## Notes
<any remaining issues noticed but not fixed>

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-mrx3xy4k/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-mrx3xy4k' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-audit-mrx3xy4k/download' --output '.skill-downloads/documentation-audit-mrx3xy4k/SKILL.md.part' && mv '.skill-downloads/documentation-audit-mrx3xy4k/SKILL.md.part' '.skill-downloads/documentation-audit-mrx3xy4k/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

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/documentation-audit-mrx3xy4k/SKILL.md' && test -s '.skill-downloads/documentation-audit-mrx3xy4k/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/docs' && cp -R '.skill-downloads/documentation-audit-mrx3xy4k' '.claude/skills/docs'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/documentation-audit-mrx3xy4k'

openskills read 'documentation-audit-mrx3xy4k'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

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-mrx3xy4k/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