Révision complète de documentation

VérifiéSûr

Orchestre une révision complète d'une page de documentation en exécutant trois compétences de vérification et en produisant un rapport structuré.

Spar Skills Guide Bot
DocumentationIntermédiaire
23/07/2026
Claude Code
#documentation-review#writing-quality#technical-accuracy#pre-merge-checks#orchestration

Recommandé pour

Synthèse automatique

Orchestre trois sous-compétences (docs-check, docs-review-style, docs-review-tech) sur un même fichier de documentation et fusionne leurs résultats en un rapport unique pass/fail assorti d'un indice de confiance.

Points forts

  • Exécute les trois batteries de contrôles en entier et dans l'ordre avant de compiler le rapport, ce qui évite les revues partielles.
  • Énumère explicitement les règles bloquantes (hard gates) de chaque sous-compétence et les seuils de tolérance associés.
  • Traduit le verdict en indice de confiance High/Medium/Low directement exploitable pour décider d'un merge.
  • Écarte automatiquement les fichiers qui ne sont pas des pages de documentation, comme les SKILL.md des agents.

Limites

  • Ne traite qu'un seul fichier par invocation : aucune revue de lot sur une PR entière.
  • Suppose que les trois sous-compétences sont installées et invocables dans l'environnement.
  • L'indice de confiance relève d'une appréciation et non d'un score calculé mécaniquement.
Quand l'utiliser

À lancer avant de fusionner une PR de documentation ou dès qu'une revue complète d'une page est demandée.

Quand l'éviter

Inutile pour auditer des instructions d'agent (SKILL.md) ou pour créer et structurer une nouvelle page.

Analyse de sécurité

Sûr
Score qualité88/100

The skill is an orchestrator for documentation review. It delegates to three named review skills and only instructs reading/analyzing a file and combining outputs. No destructive commands, exfiltration, obfuscation, or disabling of safety controls are present. Declared tools include Bash, WebFetch, and WebSearch, but the skill text itself does not direct risky shell execution; any Bash use would be incidental to delegated review skills and is legitimate for the stated purpose.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Full review before merge
/docs-review content/docs/api/authentication.md — run the full review, I want the pass/fail and confidence before I merge this PR.
Complete review of one page
Give me a complete review of docs/guides/webhooks.mdx: structural checks, style and voice, and technical accuracy, with one combined verdict.
Is this page mergeable?
Before we merge, do a full docs review of the 'Rate limits' page and tell me if it's a PASS or FAIL and how confident you are.

name: docs-review description: Runs docs-check, docs-review-style, and docs-review-tech on one file; combines results into a pass/fail report with a confidence rating. Use before merging any doc PR, or whenever asked for a full or complete review of a documentation page. allowed-tools: Read Bash WebFetch WebSearch

ThunderID Docs — Full Review

Orchestrates a complete review of one file. Runs all three review skills in sequence and combines their output into one structured report.

Usage

Invoked as /docs-review [file-path]. If no path is given, ask which file. If the path is a SKILL.md under .agent/skills/ or .claude/skills/, stop: it's agent instructions, not a documentation page.

Covers structural standards, writing quality (AI-pattern detection, voice consistency), and technical accuracy. For new pages or significant rewrites, also run /docs-seo; its findings are advisory and listed separately.


Review Sequence

Run each skill's checks in full, in order, before compiling the combined report — don't skip to the output format early.

  1. /docs-check — frontmatter, heading hierarchy, code block tags, ProductName usage, internal links, Stepper config, alt text, sidebar registration/placement.
  2. /docs-review-style — AI vocabulary, sentence cadence, promotional tone, generic writing, rhetorical scaffolding, voice vs. siblings, per-rule style (contractions, terminology, formatting, doc-type patterns), step count/decomposition, step ordering.
  3. /docs-review-tech — protocol claims, code examples, API/SDK accuracy, config claims, security claims, diagram-to-text consistency.

Don't skip any — each catches different failure modes.


Combined Output

Reviewing: [file path]
Doc type: [detected type]

─────────────────────────────────────
DOCS-CHECK
[Paste the docs-check output. Omit passing checks — show only failures and warnings.]

DOCS-REVIEW-STYLE
[Paste the docs-review-style output. Omit passing checks.]

DOCS-REVIEW-TECH
[Paste the docs-review-tech output. Omit passing checks — keep the category coverage summary.]

─────────────────────────────────────
OVERALL RESULT: PASS / FAIL
Confidence: High / Medium / Low

Hard gate failures: [count] ([which skill(s)])
Failures: [count]
Warnings: [count]

If all three pass cleanly, show only the passing summary:

DOCS-CHECK
  ✅  All checks passed

DOCS-REVIEW-STYLE
  ✅  Result: PASS — 0 failures · 0 warnings

DOCS-REVIEW-TECH
  ✅  Result: PASS — C:0 · H:0 · M:0 · L:0

─────────────────────────────────────
OVERALL RESULT: PASS
Confidence: High
Hard gate failures: 0

Confidence Rating

High — all three pass with at most 2 low-severity warnings; ready for merge review.

Medium — one or more skills produced non-gate failures or warnings; address before merging.

Low — any hard gate failure from any skill; must be revised before merge.


Hard Gate Summary

Overall review FAILS if any of these are true:

From docs-check: any ❌ FAIL (title, description length/prefix, heading hierarchy, toc_progress/Stepper consistency, ProductName in prose, absolute links, Stepper config, line dividers).

From docs-review-style (its Hard Gate Rules): any em/en dash present; 5+ AI vocabulary violations; any rhetorical scaffolding phrase; 2+ symmetric contrast constructions. (Step Count/Decomposition and Step Locality are also checked there but never gate — they resolve by asking the user, not a mechanical fail.)

From docs-review-tech: any CRITICAL issue; 3+ HIGH issues; any unverifiable code example; any security claim unverifiable against two authoritative sources; a cross-page contradiction.


Scope Boundary

| Check | This skill | Underlying skill | |---|---|---| | Structural standards | delegates | /docs-check | | Writing quality, voice, AI-pattern detection | delegates | /docs-review-style | | Technical accuracy | delegates | /docs-review-tech | | Page scaffold creation | — | /docs-new-page |

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

Outils déclarés par l’auteur (à vérifier dans votre agent) : Read Bash WebFetch WebSearch

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/full-documentation-review-mrx3xxj0/SKILL.md' && test -s '.skill-downloads/full-documentation-review-mrx3xxj0/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/docs-review' && cp -R '.skill-downloads/full-documentation-review-mrx3xxj0' '.claude/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/full-documentation-review-mrx3xxj0'

openskills read 'full-documentation-review-mrx3xxj0'

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/full-documentation-review-mrx3xxj0/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