La documentation fait partie du produit. Une page utile répond à une question réelle, annonce clairement ses limites et donne au lecteur une prochaine action vérifiable.
Règles éditoriales
- Écrire pour une personne précise et nommer l’objectif dès l’introduction.
- Distinguer explicitement ce qui est livré, en cours, prévu ou hypothétique.
- Utiliser des exemples synthétiques et reproductibles.
- Préférer une commande testée à une longue explication abstraite.
- Documenter la raison d’une décision d’architecture, pas uniquement son résultat.
- Dater les changements qui modifient un comportement opérationnel.
Définition de terminé
- Exactitude
La page correspond à la version réellement déployée.
- Lecture
Les titres, tableaux et exemples permettent une lecture rapide.
- Vérification
Les commandes et liens ont été testés.
- Responsabilité
Un propriétaire et une date de mise à jour sont identifiables.