Aller au contenu

Ownership : qui maintient la documentation ?

Mise à jour :

Vous avez créé une belle documentation. Tout le monde l’a félicitée. Six mois plus tard, elle est obsolète. Personne ne l’a mise à jour parce que… personne ne savait que c’était son travail.

Ce scénario se répète dans la majorité des équipes techniques. Non pas par paresse, mais par absence de clarté sur les responsabilités.

Ce guide vous apprend à définir précisément qui est responsable de quoi, pour que votre documentation reste vivante, utile et digne de confiance.

Le problème : “C’est à qui de mettre à jour ?”

Un incident révélateur

Imaginez cette situation, vécue par une équipe e-commerce :

  1. L’équipe Plateforme crée un runbook pour le service de paiement
  2. Trois mois plus tard, l’équipe Checkout modifie la configuration du service
  3. L’équipe Plateforme n’est pas informée — le runbook reste inchangé
  4. Un incident survient à 3h du matin. L’astreinte suit le runbook obsolète
  5. La procédure échoue. L’incident dure 2h au lieu des 15 minutes prévues

Qui est fautif ? La réponse instinctive pointe vers l’équipe Checkout qui n’a pas mis à jour la doc. Mais la vraie question est : savaient-ils qu’ils devaient le faire ?

Le problème n’est pas la négligence. C’est l’absence de règles claires sur l’ownership. Je sais de quoi je parle : j’ai vu ce scénario se répéter plusieurs fois dans différentes structures.

Ce que coûte l’absence d’ownership

ConséquenceImpact concret
Documentation obsolèteProcédures qui échouent, incidents prolongés
Duplication d’effortsPlusieurs personnes rédigent la même chose
Conflits d’équipe”Ce n’est pas mon job de maintenir ça”
Perte de confianceL’équipe cesse de consulter la doc
Dette technique cachéeAccumulation de docs orphelines

L’analogie du jardin partagé

Pour comprendre l’importance de l’ownership, pensez à un jardin communautaire.

Sans règles définies : personne ne sait qui doit arroser, qui désherbe, qui taille. Résultat prévisible : les mauvaises herbes envahissent, les plantes meurent, le jardin devient une friche.

Avec des parcelles assignées : chaque jardinier connaît sa zone de responsabilité. Il peut demander de l’aide, échanger des conseils, mais il sait que sa parcelle lui appartient. Le jardin prospère.

La documentation fonctionne exactement de la même façon. Sans ownership clair, elle se dégrade naturellement — c’est une loi de l’entropie informationnelle.

Le modèle RACI appliqué à la documentation

Le modèle RACI est un framework de clarification des responsabilités utilisé en gestion de projet. Appliqué à la documentation, il répond à quatre questions essentielles.

Modèle RACI appliqué à la documentation : Responsible, Accountable, Consulted, Informed

Les quatre rôles expliqués

Qui fait le travail ?

Le Responsible est la personne qui rédige et met à jour le document. C’est elle qui ouvre l’éditeur, tape le contenu, soumet la PR.

Caractéristiques :

  • Plusieurs personnes peuvent être Responsible
  • Le Responsible exécute, il ne décide pas seul
  • Il doit avoir le temps et les compétences

Exemple : Le développeur qui implémente une nouvelle feature est Responsible de la mise à jour du Service Overview.

La règle d’or du RACI

Exemple concret : Service API Payments

Voici comment appliquer le RACI à un service réel :

DocumentR (rédige)A (valide)C (consulte)I (informé)
Service OverviewDev @aliceTech Lead @bobOps @charlieSupport, Produit
Runbook déploiementOps @charlieTech Lead @bobDev @aliceOn-call
Runbook incident DBDBA @dianaTech Lead @bobOps @charlieOn-call
PostmortemIncident CommanderTech Lead @bobParticipantsToute l’équipe, Management
ADR choix technoDev @aliceTech Lead @bobArchi @ericÉquipe dev

Observations :

  • Le Tech Lead est Accountable de tous les documents critiques du service
  • Les Responsible changent selon l’expertise requise
  • L’équipe On-call est systématiquement informée des runbooks

Le cycle de vie d’un document

Chaque document traverse un cycle prévisible. Comprendre ce cycle aide à définir les responsabilités à chaque étape.

Cycle de vie d'un document : Créer, Review, Publier, Maintenir

Responsabilités par phase

PhaseQui agitCe qu’il fait
CréerResponsibleRédige le premier draft, assigne l’owner
ReviewConsulted + AccountableRelecture, feedback, validation
PublierResponsibleMerge, mise en ligne, notification
MaintenirOwner (Accountable)Reviews périodiques, mises à jour

La phase Maintenir est la plus critique et la plus souvent négligée. Un document sans maintenance programmée devient obsolète en quelques mois.

Intégrer la documentation dans la Definition of Done

Le problème du “on documentera après”

Combien de fois avez-vous entendu (ou dit) cette phrase ?

“La feature est prête, on fera la doc la semaine prochaine.”

Spoiler : la semaine prochaine n’arrive jamais. Une nouvelle urgence apparaît, et la documentation reste indéfiniment dans les limbes.

La solution : intégrer la documentation dans la Definition of Done.

Qu’est-ce que la Definition of Done ?

La Definition of Done (DoD) est une checklist de critères qui définissent quand un travail est réellement terminé. Elle vient du monde Agile/Scrum mais s’applique à toute méthodologie.

L’idée clé : un travail n’est pas “done” tant que tous les critères ne sont pas remplis, y compris la documentation.

DoD avec documentation intégrée

  1. Code mergé

    La PR est approuvée et fusionnée dans la branche principale.

  2. Tests passent

    CI vert : tests unitaires, intégration, e2e selon le projet.

  3. Documentation mise à jour

    Selon l’impact de la modification :

    Type de changementDocumentation à mettre à jour
    Nouvelle featureService Overview, README
    Changement d’APIAPI Reference, exemples
    Nouvelle procédure opsCréer un runbook
    Modification configRéférentiel de configuration
    Changement d’architectureDiagrammes, ADR si décision majeure
  4. Review documentation effectuée

    Quelqu’un d’autre que l’auteur a relu et validé.

  5. Changelog mis à jour

    Entrée ajoutée pour la traçabilité.

Template de PR avec checklist documentation

Intégrez cette checklist dans votre template de Pull Request :

## Checklist avant merge
### Code
- [ ] Tests unitaires ajoutés/mis à jour
- [ ] Tests d'intégration passent
- [ ] Code review approuvée
### Documentation
- [ ] Impact documentaire évalué (voir tableau ci-dessous)
- [ ] Documentation mise à jour si nécessaire
- [ ] Review doc effectuée par un pair
- [ ] Changelog mis à jour
### Impact documentaire
<!-- Cochez ce qui s'applique -->
- [ ] Pas d'impact sur la documentation
- [ ] Service Overview mis à jour
- [ ] README mis à jour
- [ ] Runbook créé/modifié
- [ ] API Reference mise à jour
- [ ] Autre : _______________

Qui est responsable de quoi ?

Matrice par type de document

Type de documentOwner naturelRaison
Service OverviewTech Lead du serviceVision globale, décisions d’architecture
RunbookÉquipe Ops / SREUtilisateurs principaux en incident
PostmortemIncident CommanderA coordonné la résolution, connaît le contexte
ADRAuteur de la décisionConnaît le raisonnement et les alternatives
API ReferenceÉquipe Dev backendConnaît le code et les contrats
Guide utilisateurProduct OwnerConnaît les besoins utilisateurs
OnboardingEngineering ManagerResponsable de l’intégration des nouveaux

Matrice par événement déclencheur

ÉvénementAction documentationResponsibleAccountable
Nouvelle featureCréer/màj Service OverviewDev qui implémenteTech Lead
Incident résoluCréer postmortemIncident CommanderTech Lead
Nouveau serviceCréer Service Overview + runbooksÉquipe du serviceTech Lead
Changement config prodMàj référentielAuteur du changementOps Lead
Départ d’un membreTransférer ownership docsPartant + successeurManager
Refactoring majeurMàj architectureDev qui refactoriseTech Lead

Mettre en place l’ownership : guide pas à pas

  1. Inventorier la documentation existante

    Recensez tout ce qui existe : wiki, Confluence, Google Docs, README, fichiers Markdown éparpillés, notes Notion…

    Créez un tableur simple :

    DocumentEmplacementDernière màjOwner actuel

    Objectif : avoir une vue complète, même du chaos.

  2. Identifier les documents orphelins

    Pour chaque document, posez la question : “Qui est responsable de le maintenir ?”

    Si personne ne sait, ou si la réponse est “l’équipe” sans personne nommée, c’est un document orphelin — candidat à l’obsolescence.

    Marquez-les dans votre inventaire.

  3. Assigner un owner à chaque document

    Règle de choix : l’owner est soit :

    • La personne/équipe qui utilise le plus ce document
    • La personne qui connaît le mieux le sujet

    Documentez l’ownership dans le document lui-même (frontmatter, header, ou section dédiée).

    ---
    title: "Runbook : Redémarrage API Gateway"
    owner: "@ops-team"
    last_review: "2024-11-15"
    next_review: "2025-02-15"
    ---
  4. Définir les cadences de review

    Chaque type de document a une fréquence de relecture adaptée :

    TypeFréquence reviewDéclencheur additionnel
    Runbooks critiquesMensuelleAprès chaque utilisation
    Service OverviewsTrimestrielleAprès changement majeur
    RéférentielsTrimestrielleArrivées/départs
    ADRJamaisImmuables (nouvelle ADR si révision)
    PostmortemsJamaisArchives historiques
  5. Automatiser les rappels

    Ne comptez pas sur la mémoire humaine. Mettez en place :

    • Calendrier partagé : événements récurrents pour les reviews
    • Bot Slack/Teams : rappels automatiques aux owners
    • CI/CD : vérification de la date de dernière mise à jour
    Terminal window
    # Exemple : script qui liste les docs à reviewer
    find docs/ -name "*.md" -mtime +90 -print
  6. Intégrer dans les processus existants

    • Ajoutez la checklist doc dans votre template de PR
    • Incluez la review doc dans vos sprints
    • Mentionnez la doc dans vos rétrospectives

Transférer l’ownership lors d’un départ

Quand quelqu’un quitte l’équipe (départ, changement de poste, congé long), ses documents doivent être explicitement transférés. Sinon, ils deviennent orphelins.

Checklist de transfert

2 semaines avant (minimum) :

  • Lister tous les documents dont la personne est owner
  • Identifier un nouvel owner pour chaque document
  • Planifier les sessions de transfert (30 min par doc critique)
  • Vérifier que le nouvel owner a les accès nécessaires

1 semaine avant :

  • Sessions de transfert effectuées
  • Le nouvel owner a relu et validé sa compréhension
  • Métadonnées mises à jour (owner dans les docs)
  • Nouvel owner ajouté aux canaux de notification

Mesurer l’efficacité de l’ownership

Comment savoir si votre système d’ownership fonctionne ?

KPIs à suivre

MétriqueCalculObjectifSignal d’alerte
% docs avec ownerDocs avec owner / Total docs> 95%< 80%
Âge moyen dernière màjMoyenne des dates de màj< 6 mois> 1 an
Docs màj post-incidentDocs màj dans 7j après incident / Total incidents100%< 50%
Temps pour trouver l’ownerTemps moyen pour identifier qui contacter< 1 min”Faut demander”
Taux de docs orphelinsDocs sans owner / Total docs0%> 5%

Audit trimestriel

Programmez un audit léger chaque trimestre :

## Audit documentation Q1 2025
### Inventaire
- Total documents : 47
- Avec owner identifié : 45 (96%)
- Sans owner (orphelins) : 2
### Documents orphelins identifiés
1. `wiki/legacy/old-deploy-process.md` — À archiver
2. `docs/api/deprecated-v1.md` — À supprimer (API dépréciée depuis 2 ans)
### Fraîcheur
- Mis à jour < 3 mois : 28 (60%)
- Mis à jour 3-6 mois : 12 (25%)
- Mis à jour > 6 mois : 7 (15%) — À reviewer
### Actions
- [ ] Archiver les 2 docs orphelins
- [ ] Planifier review des 7 docs > 6 mois
- [ ] Rappeler la DoD à l'équipe (2 PRs sans màj doc ce trimestre)

Anti-patterns à éviter

Anti-patternPourquoi c’est problématiqueSolution
”L’équipe est owner”Responsabilité diffuse = pas de responsabilitéNommer une personne (qui peut déléguer)
Owner = créateur originalIl a peut-être changé d’équipe depuisOwner = utilisateur principal actuel
Ownership non documenté”Je crois que c’est Jean…”Owner écrit dans le document
Pas de backupOwner en vacances = doc bloquéeDésigner owner + backup
Owner sans tempsResponsable mais jamais de temps allouéInclure la maintenance doc dans la charge
Ownership informel”Tout le monde sait que c’est moi”Formaliser par écrit

Checklist récapitulative

Avant de considérer votre système d’ownership comme opérationnel :

  • Chaque document critique a un owner nommé et documenté
  • La DoD de l’équipe inclut la documentation
  • Les templates de PR incluent la checklist doc
  • Les cadences de review sont définies par type de document
  • Un processus de transfert existe pour les départs
  • Des rappels automatiques sont en place
  • Un audit trimestriel est programmé

Pour aller plus loin

L’ownership définit qui maintient. Mais comment s’assurer que la maintenance est effectivement faite ?

Références