Review et iteration
Verifie, score et itere sur la qualite documentaire avec checklist, grille de scoring et boucle de review.
Ecrire est la moitie du travail. Reviewer est l'autre moitie. Voici comment verifier, scorer et iterer.
Checklist de review rapide (2 min)
A passer sur CHAQUE page avant publication.
Style (les 38 regles)
- Phrases de max 25 mots ?
- Voix active, 2e personne ("tu") ?
- Present, pas futur ?
- Condition avant instruction ?
- Zero filler words ("simplement", "facilement", "juste") ?
- Pas de conditionnel inutile ?
- Pas d'auto-reference ("cette page explique") ?
- Info importante en debut de paragraphe ?
- Listes en structures paralleles ?
- Pas de reference a une version specifique ?
- 1 phrase = 1 ligne dans le source ?
- Acronymes developpes a la premiere occurrence ?
- Formatage inline correct (code/gras/italique) ?
- Pas de point final dans les items de liste courts ?
Structure
- Type Diataxis identifie et respecte (pas de melange) ?
- Frontmatter complet (title + description) ?
- H2 = une idee specifique ?
- Pas de saut de niveau de titre (H2 → H4 interdit) ?
- Max H4 de profondeur ?
- Max 2 callouts ?
- Page de moins de 2000 mots ?
- Donnees structurees en tables, pas en prose ?
Code et visuels
- Code blocks avec langage specifie ?
- Placeholders explicites (YOUR_TOKEN, [description]) ?
- Pas de vrai token ou PII ?
- Alt text sur chaque image ?
- SVG pour les diagrammes ?
Code annotations
- Commentaires inline expliquent le POURQUOI, pas le QUOI ?
- TODO/FIXME/HACK avec auteur et contexte ?
- Pas de code mort commente sans marqueur (TODO/FIXME) ?
- Decisions d'architecture documentees en commentaire de bloc ?
Navigation
- Au moins 2 liens internes ?
- Section "Lecture liee" en fin de page ?
- Fichier liste dans meta.json ?
- Dossier parent a un index.mdx ?
Metadata
- Title de max 60 caracteres ?
- Description de max 160 caracteres ?
- Status renseigne (draft, review, published, deprecated) ?
-
human_checkrenseigne ? - Tags presents et pertinents ?
- Dates au format ISO 8601 (YYYY-MM-DD) ?
SEO (Search Engine Optimization)
- Mot-cle principal dans le title ?
- Description actionnable (commence par un verbe) ?
- Slug court, sans mots vides ?
- Premiere phrase contient le mot-cle principal ?
- H2 et H3 utilisent des variantes du mot-cle ?
Depreciation et versioning
- Si deprecated : status mis a jour dans le frontmatter ?
- Si deprecated : callout de depreciation en haut de page ?
- Si deprecated : redirect vers la nouvelle page ?
- Changements documentes dans le changelog ?
Grille de scoring (review approfondie)
Pour une review detaillee, scorer chaque critere de 0 a 2.
| Critere | Poids | 0 | 1 | 2 |
|---|---|---|---|---|
| Diataxis | 15% | Types melanges | Surtout un type | Purement un type |
| Ecriture | 15% | Murs de texte, passif | Correcte | Directe, concise, active |
| Exemples | 15% | Aucun ou casses | Presents | Testables, complets |
| Structure | 15% | Pas de pattern | Partiel | Template respecte |
| Navigation | 10% | Zero lien | Quelques liens | Cross-links + lecture liee |
| DX (Developer Experience) | 10% | Rien | Search + TOC | Search + TOC + callouts + code copy |
| Metadata | 10% | Manquante | Partielle (title + desc) | Complete (title, desc, status, tags, dates) |
| SEO | 10% | Aucun effort | Title et desc OK | Title, desc, slug, H2, premiere phrase optimises |
Formule de scoring
score_final = sum(score_i * poids_i) / sum(2 * poids_i) * 100Exemple : une page obtient Diataxis=2, Ecriture=1, Exemples=2, Structure=2, Navigation=1, DX=1, Metadata=2, SEO=1.
numerateur = (2*15 + 1*15 + 2*15 + 2*15 + 1*10 + 1*10 + 2*10 + 1*10)
= 30 + 15 + 30 + 30 + 10 + 10 + 20 + 10 = 155
denominateur = 2 * (15+15+15+15+10+10+10+10) = 2 * 100 = 200
score = 155 / 200 * 100 = 77.5%Verdict : 77.5% = Bon. Publier, ameliorer plus tard.
Interpretation du score
| Score | Verdict | Action |
|---|---|---|
| 90-100% | World-class | Publier |
| 70-89% | Bon | Publier, ameliorer plus tard |
| 50-69% | Insuffisant | Corriger avant publication |
| Moins de 50% | Reecrire | Ne pas publier en l'etat |
Boucle d'iteration
ECRIRE → REVIEW → CORRIGER → RE-REVIEW → PUBLIER
┌─────────────────────────────────┐
│ │
ECRIRE ──► SELF-REVIEW ──► CORRIGER ─┤
│ │ │
│ Score inferieur a 70% ? │
│ Oui → Corriger │
│ Non → Continuer │
│ │
├──► PEER-REVIEW ──► CORRIGER ────┤
│ │ │
│ Problemes ? │
│ Oui → Corriger │
│ Non → Publier │
│ │
└──► PUBLIER ─────────────────────┘Self-review (obligatoire)
Tu passes la checklist rapide sur ta propre page. Corrige les violations evidentes.
Peer-review (recommande)
Un second regard verifie :
- Le contenu est-il factuel ?
- Un debutant comprend-il sans contexte prealable ?
- Les exemples fonctionnent-ils reellement ?
- La navigation est-elle fluide ?
Review periodique (trimestrielle)
Tous les 3 mois, auditer l'ensemble de la doc :
- Pages obsoletes → mettre a jour ou archiver
- Liens morts → corriger
- Contenu duplique → fusionner
- Pages sans trafic → evaluer l'utilite
- Metadata incomplete → completer title, description, status, tags
- Screenshots obsoletes → recapturer ou supprimer
- Pages deprecated → verifier redirect et appliquer la regle des 90 jours
Patterns de problemes recurrents
| Probleme | Signal | Fix |
|---|---|---|
| Mur de texte | Paragraphe de plus de 3 phrases | Split + ajouter un H2 |
| Page fourre-tout | Page de plus de 2000 mots | Split en pages par type |
| Zero exemples | Pas de code block | Ajouter 1 exemple par section |
| Liens morts | Card ou lien vers 404 | Verifier avec npm run build |
| Jargon non defini | Terme technique sans explication | Definir a la premiere occurrence |
| Type Diataxis melange | Tutorial + reference dans la meme page | Split en 2 pages |
| Callout overload | Plus de 2 callouts par page | Convertir en texte gras |
| Passif | "est configure" au lieu de "configure" | Reecrire en voix active |
| Futur | "va creer" au lieu de "cree" | Reecrire au present |
| Auto-reference | "Cette page explique" | Supprimer, aller droit au contenu |
| Lecture liee manquante | Pas de section "Lecture liee" en fin de page | Ajouter avec 2-3 liens contextuels |
| Metadata incomplete | Title ou description absents, pas de status | Completer le frontmatter |
| Screenshot obsolete | Image qui ne correspond plus a l'interface actuelle | Recapturer ou supprimer |
| Page deprecated sans redirect | Status deprecated mais pas de deprecated_redirect | Ajouter le redirect + callout |
| TODO sans contexte | TODO sans auteur ni ticket | Ajouter TODO(auteur): description — ticket |
Review par un agent IA
Si un agent IA review la doc, il doit verifier dans cet ordre :
Pass 1 — Structure (5 sec/page)
- Frontmatter complet ?
- Type Diataxis identifiable ?
- H2 specifiques, pas de saut de niveau ?
- Longueur inferieure a 2000 mots ?
Pass 2 — Style (15 sec/page)
- Phrases de plus de 25 mots ?
- Passif detecte ?
- Filler words ?
- Tutoiement uniforme ?
Pass 3 — Completude (10 sec/page)
- Exemples presents ?
- Liens internes (min 2) ?
- Callouts max 2 ?
- Section "Lecture liee" ?
Pass 4 — Metadata et SEO (5 sec/page)
- Title de max 60 caracteres ?
- Description de max 160 caracteres, actionnable ?
- Slug court et descriptif ?
- Mot-cle dans le title et la premiere phrase ?
- Status et tags renseignes ?
Pass 5 — Cycle de vie (5 sec/page)
- Status coherent avec le contenu ?
- Pages deprecated avec callout et redirect ?
- Dates a jour (created, updated) ?
- Changelog a jour si modification recente ?
Output attendu
## Review [nom-du-fichier.mdx]
Score: XX/100
### Violations
- [Regle N] ligne XX : "[extrait]"
### Metadata
- Title: [OK | trop long | manquant]
- Description: [OK | trop longue | non actionnable | manquante]
- Status: [OK | manquant]
- Tags: [OK | manquants]
### SEO
- Mot-cle principal: [mot-cle detecte]
- Present dans title: [oui | non]
- Present dans premiere phrase: [oui | non]
- Slug: [OK | trop long | mots vides]
### Actions requises
1. [Action prioritaire]
2. [Action secondaire]Qualite profonde (au-dela de la checklist)
La checklist mesure la qualite fonctionnelle (accuracy, completeness, consistency). La qualite profonde est ce qui rend la doc agreable a utiliser. Elle ne se mesure pas, elle se ressent.
| Critere | Question a se poser |
|---|---|
| Flow | Le lecteur progresse-t-il sans friction d'une section a l'autre ? |
| Anticipation | La doc repond-elle aux questions AVANT que le lecteur les pose ? |
| Rythme | L'alternance code/prose/table cree-t-elle un rythme agreable ? |
| Adaptabilite | Le lecteur peut-il adapter le contenu a son contexte reel ? |
La qualite profonde est conditionnelle a la qualite fonctionnelle. Pas de flow sans accuracy.
Quand NE PAS reviewer
| Situation | Pourquoi |
|---|---|
| Draft en cours | Le review casse le flow d'ecriture |
| Brainstorm / inbox | Le contenu n'est pas encore structure |
| Notes personnelles | Pas destine a etre publie |
Review = contenu pret a etre lu par quelqu'un d'autre. Pas avant.
Lecture liee
- Regles de redaction — les 38 regles de style
- Formats de contenu — 10 templates par type
- Structurer un contenu — decouper, ordonner, versionner, deprecier