Couches de validation

Pourquoi les couches sont importantes

Aucune méthode de validation unique ne suffit.

• la documentation seule n’impose pas le comportement
• les tests seuls peuvent valider de fausses hypothèses
• CI ne peut pas à elle seule définir les règles qu’elle est censée faire respecter

Une approche en couches est plus solide car chaque couche capte une forme différente de dérive.

Couches de validation communes

1. Spécifications et conseils

La première couche définit la règle.

Sans cette couche, les contrôles ultérieurs pourraient être stricts mais arbitraires.

2. Examen manuel

L’examen humain vérifie l’intention, les cas limites et la signification du produit qui ne sont peut-être pas encore automatisés.

3. Validation locale

Les scripts et les vérifications structurées détectent rapidement les problèmes reproductibles avant que les modifications n’atteignent CI.

4. Essais

Les tests exécutables vérifient le comportement attendu, mais uniquement lorsqu’ils sont alignés sur les spécifications.

5. Portes CI

CI rend les contrôles reproductibles et visibles entre les contributeurs et les environnements.

6. Vérifications du déploiement

Les workflows de déploiement confirment que les artefacts créés sont toujours publiables et structurellement solides.

Comment les calques doivent être liés

Les couches doivent se renforcer mutuellement dans cet ordre :

• les documents et spécifications définissent les attentes
• l’examen interprète ces attentes dans leur contexte
• les scripts de validation et les tests automatisent les parties stables de la revue
• CI effectue ces contrôles de manière cohérente
• le déploiement garantit que la sortie peut réellement être publiée

Bons objectifs de validation précoce

Voici des exemples de premiers candidats solides :

• présence du fichier requis
• exhaustivité de la localisation
• validité de la syntaxe
• liens internes rompus
• citations éditoriales interdites
• succès de la génération de métadonnées

Ces contrôles ont tendance à être objectifs et peu coûteux.

Let Books contexte

Le référentiel Let Books documente déjà plusieurs couches, notamment :

• règles de produit et de mise en œuvre aux AGENTS.md et AGENTS-Implementation.md
• validation du développement et du déploiement aux docs/Development.md et docs/Deployment.md
• règles de preuve éditoriale dans docs/blog/README.md et docs/sources/README.md
• guide d’apprentissage pour introduire CI et validation par étapes

Cela fait de la validation un système documenté plutôt qu’une simple aspiration future.

Pages connexes

• documentation-traceability.md
• implementation-guidance.md
• ../../learning/fr/how-to-add-validation-rules-and-ci-gates-in-stages.md
• ../../blog/fr/documentation-is-part-of-the-product.md