Génération automatisée de documentation technique par IA - Workflow n8n

Une chaîne formatée en Markdown contenant une liste à puces.
Spécialistes de l'automatisation n8n qui créent des modèles de workflow n8n complexes.
Rédacteurs techniques ayant besoin de documenter rapidement les processus n8n.
Équipes nécessitant une documentation cohérente et standardisée intégrée directement dans leurs workflows n8n.
Utilisateurs recherchant des exemples avancés sur la manière de combiner code personnalisé et IA dans un workflow n8n.

Maintenir la documentation des workflows n8n complexes peut prendre beaucoup de temps. Ce workflow n8n spécialisé résout ce problème en automatisant la génération de post-its structurés et de haute qualité pour chaque élément d'un modèle n8n cible.

Il utilise la puissance de gpt-4o-mini pour analyser la configuration de chaque nœud n8n, rédigeant des explications claires, les détails des paramètres clés et des conseils de validation. L'automatisation gère l'intégralité du processus : chargement du workflow n8n cible, analyse (parsing) du JSON, génération des notes, calcul d'une mise en page organisée (RTL), et sauvegarde du workflow n8n finalisé et entièrement documenté sur le disque. Ceci est un outil n8n essentiel pour passer à l'échelle des efforts de documentation.

Une description étape par étape de ce puissant workflow n8n :

1. Déclenchement et Définition du Contexte : Le workflow n8n est démarré à l'aide du déclencheur n8n When clicking ‘Execute workflow’ (Lors du clic sur ‘Exécuter le workflow’). Un nœud n8n Set suivant (Your Workflow Description) fournit le contexte général sur le workflow en cours de documentation à l'IA.


2. Chargement du Workflow : Le nœud n8n load workflow (Lecture/Écriture de Fichier) lit le fichier JSON du workflow cible depuis le chemin défini.


3. Analyse (Parsing) et Filtrage : Le nœud n8n Parse Workflow (Code) valide la structure d'entrée, filtre tous les nœuds stickyNote existants et crée un tableau des nœuds n8n 'réels' prêts à être documentés.


4. Documentation Globale : Le nœud n8n Overall Sticky Note (OpenAI) reçoit un résumé de la structure du workflow n8n et utilise le LLM pour générer une note de synthèse de haut niveau. Ce contenu est préparé pour l'assemblage final.


5. Documentation par Nœud : Les nœuds filtrés sont séparés en éléments individuels (Split Out Items), et chaque élément est transmis au nœud n8n Node Sticky Notes (OpenAI). Ce nœud utilise une requête spécialisée pour analyser la configuration JSON de ce nœud n8n unique et générer une ébauche de post-it de documentation détaillée.


6. Calcul de la Mise en Page : Le nœud n8n Layout Blocks RTL (Code) prend le contenu du post-it nouvellement généré et les données du nœud n8n d'origine. Il calcule les positions optimisées, garantissant que le post-it est placé sous son nœud n8n correspondant dans une disposition lisible de droite à gauche (RTL).


7. Assemblage Final : Tous les composants — le workflow d'origine, les nouvelles positions des nœuds, le contenu de la note de synthèse globale, et les post-its par nœud — sont fusionnés (Merge1, Merge2). Le nœud Assemble Workflow (Code) intègre ces parties, assurant la suppression propre des anciens post-its et le positionnement correct de tous les éléments dans le JSON du workflow n8n documenté final.


8. Sauvegarde du Résultat : Le workflow n8n documenté final est sauvegardé en tant que nouveau fichier JSON à l'aide du nœud n8n Save documented Workflow.

Une chaîne formatée en Markdown expliquant l'installation et la configuration des identifiants (credentials).

🚀 Guide d'Installation

1. Importer le workflow n8n : Copiez le code JSON fourni et importez-le dans votre instance n8n via la section Workflows (Importer depuis JSON).


2. Identifiants OpenAI (Credentials) : Ce workflow n8n nécessite une configuration d'identifiant OpenAI.

1. Exécution : Cliquez sur 'Execute workflow' pour lancer l'automatisation et générer le résultat documenté.

Une chaîne formatée en Markdown listant les nœuds clés.

When clicking ‘Execute workflow’ (Déclencheur Manuel)
Fonction : Sert de déclencheur n8n de départ pour l'exécution manuelle, initiant l'ensemble du processus de documentation.
Configuration Clé : Aucune, c'est un simple déclencheur n8n.

load workflow (Lecture/Écriture de Fichier)
Fonction : Charge le fichier JSON brut du workflow n8n cible nécessitant une documentation.
Configuration Clé : Le paramètre File Selector doit être mis à jour avec le chemin du fichier du workflow cible.

Parse Workflow (Code)
Fonction : Logique personnalisée pour gérer divers formats d'enveloppement JSON, filtrer les types de nœuds n8n stickyNote existants et préparer un tableau propre des nœuds réels pour l'IA.
Configuration Clé : Contient une logique JavaScript pour déballer la structure du workflow et synthétiser les nœuds.

Overall Sticky Note (OpenAI)
Fonction : Génère l'aperçu documentaire de haut niveau pour l'ensemble du workflow n8n en utilisant gpt-4o-mini, basé sur une instruction système détaillée de rédacteur technique.
Configuration Clé : Utilise le modèle gpt-4o-mini et reçoit le texte de résumé du workflow comme contexte d'entrée.

Node Sticky Notes (OpenAI)
Fonction : Itère sur chaque nœud n8n, générant un post-it technique spécifique détaillant son objectif, ses entrées/sorties et ses champs clés.
Configuration Clé : Utilise le modèle gpt-4o-mini, interrogeant l'IA avec la structure JSON du nœud n8n spécifique.

Layout Blocks RTL (Code)
Fonction : Un nœud n8n à code personnalisé complexe qui calcule le positionnement visuel optimal pour chaque nœud n8n et son post-it nouvellement créé, les arrangeant de droite à gauche (RTL) sur le canevas pour maintenir l'organisation visuelle.
Configuration Clé : Définit les paramètres constants pour les dimensions des nœuds et des post-its (NODEW: 300, STICKYW: 380, GAPX, GAPY).

Assemble Workflow (Code)
Fonction : L'étape finale de ce workflow n8n. Il reconstruit le JSON du workflow cible, injectant le post-it de synthèse globale, appliquant tous les déplacements de nœuds calculés et insérant les post-its individuels par nœud n8n.
Configuration Clé : Inclut une logique pour appliquer les déplacements, supprimer les anciens post-its et positionner la note de synthèse tout à gauche.

Save documented Workflow (Lecture/Écriture de Fichier)
Fonction : Écrit le modèle JSON du workflow n8n entièrement documenté vers le chemin de fichier de sortie.
Configuration Clé : Le paramètre File Name définit le chemin de sortie pour le nouveau fichier de workflow.