Rubriques

Intelligence artificielle Automatisation Veille Écosystème lyonnais

Le site

Tous les articles Le média Nous écrire
Automatisation

Documenter ses automatisations pour ne pas dépendre d’une seule personne

Le risque principal d’un parc d’automatisations n’est pas la panne, c’est le départ de celui qui l’a construit. Ce qu’il faut écrire, où, et dans quel format.

Documenter ses automatisations pour ne pas dépendre d’une seule personne

Dans un parc d’automatisations, la panne n’est pas le pire scénario. Le pire scénario, c’est le départ de la personne qui a tout construit. Une documentation d’automatisation correcte ne sert pas à faire joli dans un audit : elle sert le jour où quelqu’un d’autre doit modifier un workflow qu’il n’a jamais vu, sous pression, parce qu’un client attend.

Maintenir ses workflows sur trois ans coûte en réalité plus cher que les construire, et le phénomène est mécanique. Les plateformes d’orchestration ont rendu la construction si rapide qu’un parc de trente ou quarante scénarios s’accumule en dix-huit mois, souvent porté par une seule personne motivée. Les scénarios fonctionnent, personne ne les regarde, et la connaissance vit dans une seule tête. C’est la forme la plus courante de dette technique no-code.

Cet article propose une réponse volontairement minimale : cinq informations à écrire par automatisation, deux endroits où les ranger, un gabarit d’une page, et un exercice de vérification qui prend deux heures par trimestre. Tout ce qui dépasse ce périmètre ne sera pas maintenu, et une documentation non maintenue est pire qu’aucune documentation.

Le vrai risque : personne ne sait pourquoi ce workflow existe

Quand une personne reprend un parc qu’elle n’a pas construit, elle ne bute pas sur la technique. Elle lit les étapes, elle comprend ce que fait le scénario. Ce qu’elle ne peut pas deviner, c’est l’intention : pourquoi ce filtre exclut les commandes inférieures à 50 euros, pourquoi ce champ est recopié dans deux systèmes, pourquoi cette temporisation de quinze minutes existe.

Ces décisions ont toutes une raison, souvent née d’un incident. Sans elles, la personne qui reprend prend l’une des deux mauvaises décisions : elle n’ose toucher à rien, et le parc se fige, ou elle nettoie ce qui lui semble inutile, et l’incident d’origine revient.

Trois symptômes signalent que la situation est déjà installée : une seule personne est capable de dire ce que fait chaque scénario, des workflows portent des noms comme « test 2 » ou « copie de facturation v3 », et personne ne sait dire lesquels sont encore actifs. Si vous cochez deux cases sur trois, la reprise d’un workflow par un tiers est déjà hors de portée.

Les cinq informations à écrire, et rien d’autre

Documenter ne veut pas dire décrire les étapes. Une capture d’écran du scénario est inutile : l’outil montre déjà les étapes, et la capture est fausse au premier changement. Ce qu’il faut écrire, c’est ce que l’outil ne montre pas.

InformationCe qu’elle évite
1. L’intention : à quel besoin métier ce scénario répond, en trois phrases, et qui s’en plaindrait s’il s’arrêtaitQu’on supprime un scénario utile, ou qu’on maintienne un scénario devenu inutile
2. Le déclencheur et la fréquence : ce qui lance le scénario, à quel rythme, et le volume typique par exécutionDes heures de recherche pour comprendre pourquoi « ça part tout seul » à 6 h du matin
3. Les dépendances : systèmes touchés, comptes utilisés, emplacement des identifiants, droits nécessairesLe blocage total le jour où un compte de service est désactivé
4. Les décisions non évidentes : chaque règle bizarre, avec sa raison et sa dateLa réintroduction d’un bug corrigé il y a un an
5. Le comportement en cas d’échec : qui est alerté, ce qui se passe pour les données en cours, comment on rejoueLa découverte d’une panne trois semaines plus tard par un client

Le cinquième point suppose que le comportement en cas d’échec ait été conçu, ce qui n’est pas toujours le cas : notre article sur la façon de gérer les erreurs dans les workflows automatisés traite cette conception, dont la documentation n’est que la trace écrite.

Où ranger la documentation d’une automatisation pour qu’elle soit relue

Une documentation dans un endroit que personne n’ouvre n’existe pas. Deux emplacements suffisent, et ils sont complémentaires.

Dans le scénario lui-même. Les plateformes d’orchestration permettent de nommer chaque étape et d’y ajouter une note. C’est là que doivent vivre les décisions non évidentes, collées à l’endroit qu’elles expliquent. Une règle simple à imposer : toute condition qui ne se comprend pas en trois secondes porte une note d’une ligne, commençant par « pourquoi ». Cette documentation est la seule qui ne se désynchronise jamais, puisqu’elle voyage avec le scénario.

Dans un registre unique, hors de la plateforme. Une page ou un tableau qui liste toutes les automatisations avec leur nom exact, leur intention en une phrase, leur propriétaire, leur criticité et leur date de dernière revue. Ce registre répond aux questions que personne ne peut poser à l’outil : combien en avons-nous, lesquelles sont critiques, qui appelle-t-on. Il est aussi le seul document utilisable par une direction ou un auditeur.

Deux conventions font gagner plus de temps que la documentation elle-même : un nommage strict (domaine, objet, fréquence, par exemple « Ventes / Relance devis / quotidien ») et une discipline de nettoyage. Un scénario désactivé depuis trois mois se supprime, après export. Sur les plateformes qui le permettent, versionner les définitions dans un dépôt et séparer les environnements de test et de production apporte un historique complet des modifications, y compris de celles que personne n’a pensé à documenter : les grandes lignes en sont posées dans notre article sur les workflows n8n avancés et l’intégration d’API.

Le gabarit d’une page qui survit un an

Un format qui tient dans la durée est un format qu’on remplit en dix minutes. Voici la trame, à copier pour chaque automatisation :

  • Nom exact tel qu’il apparaît dans l’outil, et lien direct vers le scénario.
  • À quoi ça sert : trois phrases maximum, écrites pour quelqu’un qui ne connaît pas le processus.
  • Propriétaire métier et propriétaire technique : deux noms, éventuellement la même personne, jamais zéro.
  • Criticité : critique (arrêt de service ou impact client), importante (perte de temps), confort.
  • Déclencheur, fréquence, volume moyen.
  • Systèmes et comptes utilisés, avec l’emplacement des identifiants (jamais leur valeur).
  • Décisions à connaître : la liste des règles non évidentes, datées.
  • En cas de panne : qui est alerté, quel est le mode dégradé manuel, comment rejouer les éléments perdus.
  • Dernière revue : une date, mise à jour à chaque relecture.

Cette dernière ligne est la plus importante du document. Une fiche sans date de revue devient invérifiable au bout de six mois : personne ne sait si elle décrit encore la réalité. Une fiche datée d’il y a onze mois est un signal clair.

L’exercice de reprise, deux heures par trimestre

La seule façon de savoir si une documentation fonctionne est de la tester, exactement comme une sauvegarde. L’exercice est simple et se pratique par binômes.

  1. Choisissez deux automatisations, dont une critique, que la personne testée n’a pas construites.
  2. Donnez-lui la fiche et l’accès, sans son auteur dans la pièce, et demandez trois choses : expliquer ce que fait le scénario, décrire ce qui se passe s’il échoue ce soir, effectuer une modification mineure définie à l’avance.
  3. Notez chaque question qu’elle a dû poser pour s’en sortir. Chacune de ces questions est un trou dans la documentation, et se corrige immédiatement.

Deux heures par trimestre suffisent à couvrir un parc de trente scénarios en un an, en commençant par les plus critiques. Cet exercice a un effet secondaire utile : il révèle aussi les automatisations que plus personne ne revendique, candidates naturelles à la suppression.

La question de la propriété se pose enfin au niveau de l’hébergement : selon que la plateforme est auto-hébergée ou souscrite en service, ce ne sont ni les mêmes accès ni les mêmes procédures de reprise qu’il faut documenter, comme le détaille notre comparatif auto-hébergé ou SaaS pour l’automatisation.

Commencer par les trois plus critiques

Documenter un parc entier d’un coup ne se fait jamais. Prenez les trois automatisations dont l’arrêt serait le plus visible, remplissez leur fiche en une demi-journée, et instaurez une règle unique pour la suite : aucune nouvelle automatisation mise en production sans sa fiche, aucune modification sans mise à jour de la ligne de revue.

La documentation d’automatisation ne protège pas des pannes, elle protège de la dépendance à une personne. C’est un investissement de quelques heures par mois qui transforme un parc fragile en actif transmissible, et qui rend possible ce que personne n’ose faire autrement : partir en vacances.

Sources

Laisser un commentaire

Votre commentaire

Jamais publiée, jamais transmise à des tiers.

Les commentaires sont relus avant publication. Voir la politique de confidentialité.