Aller au contenu

Auto-évaluation : maturité documentation

Mise à jour :

Où en êtes-vous vraiment avec votre documentation ?

Ce questionnaire vous permet d’évaluer objectivement votre niveau de maturité et d’identifier les priorités d’amélioration.

Répondez honnêtement — c’est un diagnostic, pas un examen.

Le questionnaire

Section 1 : Existence et couverture

Q1. Vos services critiques ont-ils un Service Overview ?

  • A — Tous les services critiques (100%)
  • B — La plupart (50-99%)
  • C — Quelques-uns (< 50%)
  • D — Aucun ou presque

Q2. Avez-vous des runbooks pour les incidents fréquents ?

  • A — Oui, couvrant 80%+ des incidents
  • B — Oui, pour les principaux (50-80%)
  • C — Quelques-uns éparpillés
  • D — Non ou très peu

Q3. Les postmortems sont-ils documentés après les incidents majeurs ?

  • A — Systématiquement (100% des P1/P2)
  • B — Souvent (50-99%)
  • C — Parfois (< 50%)
  • D — Rarement ou jamais

Section 2 : Accessibilité

Q4. Combien de temps faut-il pour trouver une doc spécifique ?

  • A — < 1 minute (URL connue ou search efficace)
  • B — 1-5 minutes
  • C — 5-15 minutes
  • D — > 15 minutes ou “demander à quelqu’un”

Q5. La documentation est-elle centralisée ?

  • A — 1 URL unique pour toute la doc technique
  • B — 2-3 emplacements bien identifiés
  • C — Plusieurs endroits, pas toujours clair
  • D — Éparpillée (wiki, Drive, Slack, READMEs…)

Q6. La recherche fonctionne-t-elle bien ?

  • A — Search full-text rapide et pertinent
  • B — Search basique mais utilisable
  • C — Search limité, navigation par dossiers
  • D — Pas de search ou inutilisable

Section 3 : Maintenance

Q7. Chaque document a-t-il un owner identifié ?

  • A — Oui, écrit dans chaque document
  • B — Oui pour la plupart
  • C — Parfois, pas systématique
  • D — Non, “c’est l’équipe”

Q8. Les documents sont-ils reviewés régulièrement ?

  • A — Oui, cycle de review défini et respecté
  • B — Parfois, de manière ad-hoc
  • C — Rarement
  • D — Jamais après création

Q9. Quel âge a la doc la plus obsolète que vous connaissez ?

  • A — < 6 mois (tout est relativement frais)
  • B — 6-12 mois
  • C — 1-2 ans
  • D — > 2 ans ou “je ne sais pas”

Section 4 : Utilisation

Q10. La doc est-elle utilisée pendant les incidents ?

  • A — Systématiquement, c’est le premier réflexe
  • B — Souvent
  • C — Parfois, si on y pense
  • D — Rarement, on préfère appeler quelqu’un

Q11. Les nouveaux consultent-ils la doc pour l’onboarding ?

  • A — Oui, parcours d’onboarding basé sur la doc
  • B — Oui, comme ressource complémentaire
  • C — Un peu, mais surtout du shadowing
  • D — Non, formation orale uniquement

Q12. La doc est-elle mise à jour après les incidents ?

  • A — Systématiquement (action item du postmortem)
  • B — Souvent
  • C — Parfois
  • D — Rarement ou jamais

Section 5 : Processus

Q13. La documentation fait-elle partie de la Definition of Done ?

  • A — Oui, checklist obligatoire dans les PRs
  • B — Oui, mais pas toujours respecté
  • C — Non, c’est optionnel
  • D — Non, “on documentera plus tard”

Q14. Y a-t-il des templates pour les différents types de docs ?

  • A — Oui, templates standardisés et utilisés
  • B — Quelques templates existent
  • C — Non, chacun fait à sa façon
  • D — Non, pas de structure définie

Q15. La doc est-elle versionnée (Git ou équivalent) ?

  • A — Oui, Docs-as-Code avec review PR
  • B — Oui, versioning basique
  • C — Historique wiki limité
  • D — Non, pas de versioning

Calculez votre score

Comptage

RéponsePoints
A4 points
B3 points
C2 points
D1 point

Votre score total : ___ / 60

Interprétation

  1. Score 50-60 : Niveau Expert 🏆

    Votre documentation est exemplaire. Vous avez mis en place les bonnes pratiques et elles sont respectées.

    Prochaines étapes :

    • Partager vos pratiques avec d’autres équipes
    • Automatiser davantage (CI/CD, tests)
    • Mesurer l’impact (métriques d’usage)
  2. Score 35-49 : Niveau Avancé

    Bonne base en place. Quelques améliorations permettraient d’atteindre l’excellence.

    Prochaines étapes :

    • Identifier les 2-3 questions où vous avez C ou D
    • Prioriser les améliorations sur ces points
    • Formaliser les processus (ownership, review)
  3. Score 20-34 : Niveau Intermédiaire 📈

    Des efforts ont été faits mais la documentation n’est pas encore un réflexe ancré dans l’équipe.

    Prochaines étapes :

    • Centraliser la documentation (1 URL)
    • Définir l’ownership pour les docs existantes
    • Intégrer la doc dans la DoD
    • Créer les templates manquants
  4. Score < 20 : Niveau Initial 🚀

    La documentation est un chantier à lancer. C’est le bon moment pour partir sur de bonnes bases.

    Prochaines étapes :

    • Commencer par le minimum vital (3 Service Overviews)
    • Choisir un outil et centraliser
    • Former l’équipe aux bonnes pratiques
    • Quick wins : 1 runbook pour l’incident le plus fréquent

Plan d’amélioration par domaine

Si vous êtes faible sur “Existence et couverture” (Q1-Q3)

Priorité : créer le contenu manquant

ActionEffortImpact
Service Overview services critiques2h/serviceÉlevé
Runbook incident le plus fréquent2hÉlevé
Template postmortem1hMoyen

→ Guide : Service Overview

Si vous êtes faible sur “Accessibilité” (Q4-Q6)

Priorité : centraliser et rendre trouvable

ActionEffortImpact
Choisir 1 outil et migrer1-2 joursÉlevé
Configurer le search2hÉlevé
Créer la page d’accueil/index1hMoyen

→ Guide : Choisir ses outils

Si vous êtes faible sur “Maintenance” (Q7-Q9)

Priorité : instaurer les processus

ActionEffortImpact
Assigner un owner à chaque doc2hÉlevé
Planifier review trimestrielle1hMoyen
Ajouter date dans les docs1hMoyen

→ Guide : Ownership

Si vous êtes faible sur “Utilisation” (Q10-Q12)

Priorité : ancrer l’habitude

ActionEffortImpact
Lier les alertes aux runbooks2hÉlevé
Créer parcours onboarding4hÉlevé
Ajouter “màj doc” dans postmortem30minMoyen

→ Guide : Reviews et fraîcheur

Si vous êtes faible sur “Processus” (Q13-Q15)

Priorité : formaliser

ActionEffortImpact
Ajouter checklist doc dans PR template30minÉlevé
Créer les templates4hÉlevé
Migrer vers Docs-as-Code1-2 joursMoyen

→ Guide : 5 familles de documentation

Refaire l’évaluation

DateScoreNiveauNotes
[Date]/60
+6 mois/60
+12 mois/60

Ressources pour progresser