Unité 7 / 11

Gestion de la documentation et de l'information : Runbook, post-mortem et mémoire d'entreprise

Gains :

  • Capacité à produire un squelette de runbook, de document post-mortem et architectural à partir de notes dispersées avec l'intelligence artificielle
  • Capacité à appliquer la discipline consistant à imposer une « interdiction de fabrication » et à tester et marquer minutieusement chaque runbook dans un environnement réel
  • Capacité à comprendre qu'un mauvais runbook est plus dangereux qu'aucun runbook et à maintenir la documentation en vie tout au long du processus de modification

Gestion de la documentation et de l'information : Runbook, architecture et mémoire institutionnelle avec l'IA

La tâche la plus négligée, mais pourtant vitale, de la gestion du système est la documentation. Lorsqu'un système tombe en panne et que la personne qui l'a construit est en vacances et qu'il n'y a aucun mot écrit sur la façon de le récupérer, c'est une longue nuit pour tout le monde. La documentation est la mémoire institutionnelle qui rend écrit et accessible la manière dont un système est configuré, comment il fonctionne et que faire en cas de problème. Le type le plus critique de cette mémoire est le runbook : un guide opérationnel qui vous indique étape par étape quoi faire dans une situation donnée (service en panne, disque plein, échec de sauvegarde). Ici, l'IA résout le problème des « pages blanches » et de la « paresse », qui sont les plus grands ennemis de la rédaction de documentation : elle produit un runbook organisé à partir de vos notes dispersées, une procédure à partir d'un historique de commandes, une description à partir d'une architecture. Mais le principe critique : l’IA produit des plans et des squelettes ; C'est vous qui testez et validez chaque étape pour voir si elle est réellement correcte : un mauvais runbook est plus dangereux que pas de runbook du tout.

Dans cette unité, runbook, post-mortem (rapport d'enquête post-événement), documentation architecturale et rédaction de la base de connaissances ; Générer des brouillons avec l'IA ; et surtout, vous découvrirez les risques d’une documentation non vérifiée.

Pourquoi un mauvais runbook est-il pire que pas de runbook ?

C'est le concept le plus important de cette unité. Une équipe sans runbook est prudente et méfiante en période de panique ; réfléchit à deux fois à chaque commande. Mais quelqu'un disposant d'un runbook « officiel » lui fait aveuglément confiance : au milieu de la nuit, sous le stress, exécutant les étapes sans poser de questions. Si ce runbook est publié sans avoir été produit et testé par l’IA et qu’il comporte une erreur (une mauvaise commande, un prérequis manquant, une étape de secours ignorée), le résultat est désastreux. C'est pourquoi chaque runbook produit avec l'IA doit être exécuté du début à la fin dans un environnement réel et chaque étape doit être vérifiée avant d'être publiée. Un runbook non testé est comme une promesse rassurante mais vide de sens.

Attention : tamponnez un runbook avec « testé : [date], [personne] ». Marquez clairement les brouillons non testés avec l’étiquette « PROJET – NON VÉRIFIÉ ». Ainsi, personne n’appliquerait en toute sécurité des mesures non vérifiées en cas de crise réelle.

Anatomie d'un bon runbook

Un bon runbook se compose de parties spécifiques, et l'IA est efficace pour construire ce squelette : titre et objectif (pour quelle situation), conditions préalables (quel accès, quel outil est nécessaire), symptômes (quand dois-je utiliser ce runbook), étapes (avec des commandes numérotées et copiables), validation (comment reconnaître le succès après chaque étape), restauration (comment annuler si une étape tourne mal) et escalade (qui dois-je appeler si je n'arrive pas à comprendre). Vous pouvez donner à l'IA vos notes éparses et lui demander de les mettre dans cette structure ; Vous garantissez uniquement l’exactitude du contenu.

Pas à pas : production de documentation avec l'IA

  1. Rassemblez la matière première. Votre historique de commandes, vos notes, un ancien e-mail, un journal de discussion : le matériel réel, même s'il est désordonné, vaut mieux que la fabrication de l'IA.
  2. Demandez une structure. "Faites-en un runbook avec les en-têtes suivants : objectif, prérequis, symptôme, étapes, vérification, restauration, escalade."
  3. Interdire la fabrication. "N'ajoutez aucune commande, adresse IP, version ou étape que je ne vous ai pas donnée ; marquez toute pièce manquante comme [À REMPLIR]." Cela évite l’erreur la plus dangereuse : les étapes inventées apparemment plausibles.
  4. Masque. Utilisez un espace réservé au lieu de l'hôte, de l'adresse IP et de l'utilisateur réels ; Si le document est partagé, le secret ne doit pas être divulgué.
  5. Testez-le. Exécutez le runbook du début à la fin dans un environnement réel (de préférence de test). Corrigez toutes les étapes qui ne fonctionnent pas, manquantes ou peu claires.
  6. Tamponnez et publiez. Ajoutez la date du test, le testeur et la dernière mise à jour. La documentation est vivante ; Il doit être mis à jour lorsque le système change.

trois mini-cases

Cas 1 — 2 heures de travail, 15 minutes. Un administrateur retardait depuis des mois la documentation d'une procédure de restauration de sauvegarde. Il a donné l'historique des commandes du terminal (masqué) et quelques notes éparses à l'IA et l'a inséré dans le framework runbook. L'IA a produit un aperçu soigné en 15 minutes. L'administrateur a passé les 45 minutes suivantes à exécuter le brouillon du début à la fin sur un serveur de test et à corriger les deux étapes manquantes. Le résultat : un runbook testé et fiable.

Cas 2 — Pris faussement. Une équipe a demandé à l'IA d'écrire un runbook de redémarrage de service mais a oublié d'interdire la "fabrication". YZ a ajouté une commande "vider le cache d'abord", ce qui semble logique mais n'existe pas dans ce service. Heureusement, l'ingénieur a exécuté le runbook dans l'environnement de test ; Cette commande a donné une erreur. L’étape de test a capturé une étape inventée qui créerait de la confusion dans une crise réelle.

Cas 3 — Post-mortem accéléré. Après une panne majeure, l’équipe a dû rédiger une autopsie, mais personne n’a pu commencer. Ils ont remis la chronologie de l'événement et les journaux masqués à l'IA et ont demandé un squelette post-mortem irréprochable : résumé, impact, chronologie, cause première, actions correctives. Le plan d'IA a réduit une heure de travail à dix minutes ; L'équipe a consacré son énergie à vérifier les faits et à clarifier les mesures à prendre.

Quatre modèles copiables

1) Générer un squelette de runbook :

Votre rôle : SRE senior. Créez un runbook à partir de l’historique des notes/commandes masquées ci-dessous. Rubriques : Objectif, Conditions préalables, Symptômes (quand utiliser), Étapes (numérotées, peuvent être copiées), Vérification à chaque étape, Restauration, Escalade. RÈGLE : N'inventez aucune commande/IP/version/étape que je ne vous donne pas ; écrivez les parties manquantes [À REMPLIR]. Matériel : [note masquée]

2) Post-mortem sans blâme :

Votre rôle : facilitateur d’enquête sur incident. Rédigez un croquis post-mortem SANS BLAME à partir de la chronologie et des journaux masqués suivants : résumé, impact (durée/portée), chronologie, cause première (si vérifiée), facteurs contributifs, actions correctives (propriétaire + priorité). Ne blâmez pas la personne, concentrez-vous sur le système. N'écrivez pas la cause première sans preuves. Données : [...]

3) Description de l'architecture/service :

Rédigez un document de service à partir des informations masquées de configuration/diagramme suivantes : que fait le service, de quels composants se compose-t-il, quelles sont ses dépendances, comment les données circulent, quels ports/protocoles. Gardez-le technique mais lisible. Marquez la relation dont vous n'êtes pas sûr comme « à vérifier ». Info : [masqué]

4) Audit de remise à niveau de la documentation :

Examinez le document existant suivant et vérifiez son actualité : (1) quelles sections sont manquantes/obscures, (2) quelles étapes semblent non testées, (3) quelles informations pourraient être obsolètes ? Notez ce que je dois demander/vérifier pour chaque constatation. Document : [document masqué]

Invite faible/Invite forte

Invite faible :

Écrivez-moi un runbook de maintenance du serveur.

Il n’y a pas de véritable matériel. L'IA produit un texte, entièrement à partir de ses propres connaissances générales, qui ne correspond pas à votre environnement ou contient même des étapes inventées. Il s’agit là d’une source dangereuse de fausse confiance.

Invite puissante :

Votre rôle : SRE senior. Vous trouverez ci-dessous l'historique des commandes masquées et mes notes que j'ai implémentées dans l'événement "Disque du service de paiement plein". Créez un runbook à partir de ceux-ci : Objectif, Prérequis (accès/outil), Symptôme, Étapes numérotées (avec mes commandes), Vérification à chaque étape, Restauration, Escalade. Ne m'obligez pas à suivre un ordre que je n'ai pas donné ; Faites le blanc [À REMPLIR]. Mettez un avertissement « non testé » à la fin. Matériel : [historique des commandes masqué]

Type de document

Apport de l'IA

Contribution obligatoire de l'homme

runbook

Squelette + mise en page

Tests en environnement réel, précision

Post-mortem

Aperçu + structure

Vérifier les faits et la cause profonde

document architectural

Description + flux

Confirmer les relations et les dépendances

Article de la base de connaissances

brouillon rapide

Vérification de l'actualité et de l'exactitude

Erreurs courantes

  • Publication de runbooks non testés. Des mesures non vérifiées sont mises en œuvre aveuglément en cas de crise ; Un mauvais runbook est un désastre.
  • Ne pas imposer l’interdiction de la fabrication. Si vous ne dites pas à l'IA "n'ajoutez pas ce que je n'ai pas donné", cela produira des étapes raisonnables mais irréalistes.
  • Sauter le masquage. Le secret est divulgué lorsque le document contenant le véritable hôte, l'adresse IP et l'utilisateur est partagé.
  • Ne pas mettre à jour le document. Les documents qui ne sont pas mis à jour lorsque le système change deviennent trompeurs avec le temps.
  • Publication sans cachet. Il n’est pas clair si un document sans date et statut de test est fiable ou s’il s’agit d’un brouillon.
Conseil : La meilleure façon de maintenir la documentation « en direct » est de la lier au processus de modification : lorsqu'un système change, laissez la mise à jour du runbook concerné être l'un des critères d'achèvement de la modification. L'IA accélère la mise à jour, mais vous êtes le processus déclencheur.

En résumé

La documentation est une mémoire institutionnelle ; Le runbook est un guide opérationnel qui sauve des vies en temps de crise. L'IA produit des brouillons organisés à partir de vos notes désordonnées, résolvant ainsi le problème des pages blanches et de la paresse. Mais la vérité la plus importante est la suivante : un mauvais runbook est plus dangereux que rien du tout, car il est appliqué aveuglément en cas de crise. Interdisez donc à l'IA de « fabriquer », masquez-la, et testez et tamponnez minutieusement chaque runbook dans un environnement réel. Conservez le document en vie à mesure que le système évolue. L'IA construit le cadre ; C’est vous qui garantissez l’exactitude et les tests.

Tâche de candidature

Choisissez une procédure qui n'est pas documentée dans votre équipe (par exemple, redémarrer un service ou restaurer une sauvegarde). Masquez votre historique de commandes et vos notes pertinentes et demandez à l'IA de créer un brouillon à l'aide du modèle « Génération de squelette Runbook » ci-dessus ; Assurez-vous d’interdire les fabrications. Exécutez le brouillon dans un environnement de test et signalez et corrigez toutes les étapes interrompues/manquantes. Ajoutez la date du test et les informations sur le testeur au runbook. Notez les différences que l’IA produit et que vous corrigez au cours du processus en 5 éléments.

liste de contrôle

  • [ ] J'ai créé le runbook à partir de matériel réel (remarque, historique des commandes), ne l'ai-je pas inventé à partir de zéro ?
  • [ ] Ai-je interdit à l'IA « d'ajouter des commandes/IP/étapes que je n'ai pas données » ?
  • [ ] Ai-je masqué des informations sensibles telles que l'hôte, l'adresse IP et l'utilisateur ?
  • [ ] Ai-je exécuté et validé le runbook dans un environnement réel/de test ?
  • [ ] Ai-je ajouté la date du test, le testeur et les informations de la dernière mise à jour ?
  • [ ] Ai-je prévu de lier le document au processus de changement du système et de le maintenir à jour ?