Revue de documentation

VérifiéSûr

Auditer ou améliorer la documentation générale d'un dépôt par rapport au comportement implémenté, en mode audit seul ou édition autorisée.

Spar Skills Guide Bot
DocumentationIntermédiaire
01/11/2026
Claude CodeCursorWindsurfCopilotCodex
#docs-audit#readme#verification#technical-writing#repo-maintenance

Recommandé pour

Synthèse automatique

Ce skill audite ou améliore la documentation générale d’un dépôt en la confrontant au comportement réellement implémenté, avec un mode audit seul ou un mode édition autorisé.

Points forts

  • Distingue explicitement l’audit sans modification de l’édition limitée au périmètre confirmé
  • Vérifie les affirmations en exécutant les commandes et exemples sans effet de bord, ou en lisant le code
  • Classe les constats en actions concrètes : conserver, mettre à jour, fusionner, scinder, déplacer, archiver ou supprimer
  • Redirige les sujets spécialisés vers des skills dédiés au lieu d’élargir la demande

Limites

  • Ne couvre pas les documents spécialisés comme les specs, les parcours critiques, la dérive de changements ou les claims marketing
  • L’exécution des exemples dépend de commandes read-only ou d’un répertoire temporaire
  • Archivage, suppression ou forte expansion exigent une autorisation explicite, ce qui peut bloquer une refonte large
Quand l'utiliser

À utiliser pour auditer un README ou un ensemble de docs générales, ou pour corriger leur exactitude par rapport au code et aux commandes réelles.

Quand l'éviter

À éviter pour mettre à jour une spec, documenter un parcours critique, traiter la dérive liée à un changement récent ou réviser des arguments marketing.

Analyse de sécurité

Sûr
Score qualité86/100

The skill is purely an editorial/audit workflow: it declares no tools, requests no credentials, touches no network or destructive operations, and explicitly forbids inventing facts or broadening scope. The only execution-adjacent instruction is running documented examples for verification, which is scoped to read-only or scratch-directory runs and is a standard documentation-QA practice rather than an exfiltration or destructive pattern. No prompt-injection or role-manipulation attempts appear in the content.

Points d'attention
  • •Step 3 instructs the agent to execute documented commands/examples to verify them; this is a legitimate but non-trivial action, partially mitigated by the constraints to read-only or scratch-directory execution. If adopted, agents should treat commands found in untrusted repo docs with normal sandboxing caution.
Comment cette analyse est faite

Exemples

Audit README accuracy
Audit the README and docs/ folder against the actual CLI commands, config options, and examples in this repo. Report prioritized, evidence-backed findings only — do not edit anything.
Fix setup docs
Update the install and setup sections of README.md and docs/setup.md so they match current behavior. Keep the existing structure and voice, and don't touch other documents.
Tidy contributor docs
Review the contributor documentation and tell me which pages to keep, merge, move, or archive, citing evidence from the code and existing docs.

name: docs-review description: Audit or improve general repository documentation against implemented behavior. Use for deliberate README or documentation-quality work not owned by a more specific documentation skill.

Documentation Review

Own general repository-document quality in an explicit audit-only or authorized edit mode.

Workflow

  1. Confirm audience, document set, desired outcome, and whether the task authorizes edits.
  2. Route current-change drift to docs-drift-review, docs/context/ structure to repo-context-document, semantic contracts to spec-update, journeys to critical-journey-document, and persuasive claims to marketing-claims-review.
  3. Verify content against implementation, commands, configuration, examples, tests, metadata, and canonical documents. Run documented commands and examples when they are read-only or can run in a scratch directory, because an example that does not run is the defect readers hit first. Read the code for the rest, and say which claims you ran and which you only read.
  4. Classify evidence-backed findings as keep, update, merge, split, move, archive, or remove.
  5. In audit-only mode, return prioritized findings without edits.
  6. In edit mode, change only the confirmed document set and preserve repository structure and voice unless that structure is the requested defect.
  7. Use text-improve on changed prose without changing verified facts, required terminology, or intentional voice.
  8. Require explicit authority before archiving, removing, or materially expanding the document set.

Do not invent features, commands, architecture, benchmarks, screenshots, promises, or roadmap items; impose a generic template; or broaden a focused request.

Finish with an evidence-backed audit or verified scoped edits, plus unresolved facts that need an owner.

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-review-mvda897f/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-review-mvda897f' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-review-mvda897f/download' --output '.skill-downloads/documentation-review-mvda897f/SKILL.md.part' && mv '.skill-downloads/documentation-review-mvda897f/SKILL.md.part' '.skill-downloads/documentation-review-mvda897f/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-review-mvda897f/SKILL.md' && test -s '.skill-downloads/documentation-review-mvda897f/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/docs-review' && cp -R '.skill-downloads/documentation-review-mvda897f' '.claude/skills/docs-review'

Cursor
test -f '.skill-downloads/documentation-review-mvda897f/SKILL.md' && test -s '.skill-downloads/documentation-review-mvda897f/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/docs-review' && cp -R '.skill-downloads/documentation-review-mvda897f' '.cursor/skills/docs-review'

Codex
test -f '.skill-downloads/documentation-review-mvda897f/SKILL.md' && test -s '.skill-downloads/documentation-review-mvda897f/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/docs-review' && cp -R '.skill-downloads/documentation-review-mvda897f' '.agents/skills/docs-review'

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-review-mvda897f'

openskills read 'documentation-review-mvda897f'

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-review-mvda897f/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