Automatisierte Dokumentationserstellung für Workflows mittels GPT und Docsify - n8n-Workflow

• n8n-Benutzer mit selbst gehosteten Instanzen, die eine zentralisierte, lesbare Dokumentation benötigen.


• Automatisierungsteams, die automatisch generierte technische Dokumentationen für jeden n8n-Workflow fordern.


• Entwickler, die nach fortgeschrittenen n8n-Vorlagen suchen, welche KI-Agenten und Webhooks zur Bereitstellung dynamischer Inhalte integrieren.


• Jeder, der ein großes Portfolio an n8n-Nodes verwaltet und eine effiziente Methode zur Dokumentation von deren Zweck und Konfiguration benötigt.

Die Verwaltung der Dokumentation für zahlreiche Automatisierungen kann zeitaufwändig sein. Dieser n8n-Workflow löst dieses Problem, indem er als dynamischer Dokumentationsserver fungiert und die Leistungsfähigkeit eines KI-Large-Language-Models (LLM) nutzt, um sofort detaillierte Dokumentationen für jeden bestehenden n8n-Workflow zu generieren.

Dieser robuste n8n-Workflow integriert sich in die Docsify JS-Bibliothek und stellt eine interaktive Dokumentationsseite direkt von Ihrer n8n-Instanz bereit. Wenn ein Benutzer Dokumentation für einen bestimmten n8n-Workflow anfordert, prüft der Workflow, ob eine Markdown-Datei existiert. Falls nicht oder wenn der Benutzer die Aktion 'neu erstellen' (recreate) anfordert, ruft der Workflow die JSON-Daten des Ziel-Workflows ab, generiert ein Mermaid-Schemadiagramm mithilfe eines benutzerdefinierten n8n-Nodes und speist beides in ein OpenAI-Modell (über Langchain-Nodes) ein. Die KI generiert strukturierte, technische Dokumentationen, die dann lokal gespeichert werden. Das gesamte System unterstützt die Anzeige, Live-Bearbeitung mit Markdown-Vorschau und das Speichern des resultierenden Dokuments, was es zu einer wesentlichen n8n-Vorlage für Governance und Wissensaustausch macht.

Diese Automatisierung funktioniert hauptsächlich über zwei n8n-Trigger-Nodes vom Typ Webhook, die als API-Endpunkt für das Docsify-Frontend dienen.

1. Initialisierung: Der primäre Webhook-Trigger liefert die Hauptdatei index.html, welche die Docsify-Bibliothek lädt.


2. Routing & Datei-Prüfung: Ein sekundärer n8n-Trigger fängt alle nachfolgenden Anfragen nach Markdown-Dateien ab (wie README.md, summary.md oder spezifische Workflow-Dokumente).


3. Inhaltsbereitstellung: Für allgemeine Seiten (README.md, summary.md) fragt der Workflow die n8n-API ab, um alle verfügbaren n8n-Workflows oder Tags aufzulisten und diese in einer Markdown-Tabelle oder Navigationsleiste zu kompilieren.


4. Behandlung von Workflow-Dokumenten: Wenn eine spezifische Dokumentationsseite (docs_workflowId.md) angefordert wird, prüft das System das lokale Laufwerk auf die vorhandene Datei.


5. KI-Generierung (falls erforderlich): Wenn die Datei fehlt oder die Aktion 'neu erstellen' (recreate) gewählt wird, ruft der n8n-Workflow das JSON des Ziel-Workflows ab. Ein benutzerdefinierter Code-n8n-Node generiert ein visuelles Mermaid-Flussdiagramm der internen Logik und Verbindungstypen. Dieses Diagramm wird zusammen mit der rohen Workflow-Struktur über Langchain-n8n-Nodes an das OpenAI Chat Model zur strukturierten Dokumentationserstellung übergeben.


6. Bearbeiten und Speichern: Wird die Aktion 'bearbeiten' (edit) angefordert, liefert der Workflow eine benutzerdefinierte HTML-Seite, die einen Live-Markdown-Editor enthält (ebenfalls mit Docsify-Vorschau). Beim Speichern verarbeitet der n8n-Trigger eine POST-Anfrage, die die lokale Markdown-Datei mithilfe des n8n-Nodes Save New Doc File aktualisiert.

1. n8n-Workflow importieren: Kopieren Sie das bereitgestellte JSON und importieren Sie es in Ihre n8n-Instanz.


2. Einrichtung der Anmeldeinformationen (Credentials):

1. Konfiguration: Bearbeiten Sie den Set-n8n-Node CONFIG (ID: f41906c3-ee4c-4333-bfd5-426f82ba4bd9):

1. Aktivierung: Aktivieren Sie den n8n-Workflow. Die Haupt-Docsify-Oberfläche ist über die URL erreichbar, die vom docsify-Webhook-Trigger bereitgestellt wird.

• Webhook Trigger (docsify, single workflow): Die primären n8n-Trigger-Endpunkte, die alle eingehenden HTTP-Anfragen vom Docsify-Client behandeln und Anfragen für die Hauptseite, Tag-Listen und einzelne Dokumentationsdateien weiterleiten.


• CONFIG (Set n8n node): Speichert kritische globale Konfigurationsvariablen, einschließlich Dateipfade, Instanz-URL und das notwendige HTML/CSS-Grundgerüst für die Docsify-Oberfläche.


• n8n Node (Get All Workflows, Get Workflow tags, Fetch Single Workflow): Diese n8n-Nodes fragen die n8n-API selbst ab, um Daten über vorhandene n8n-Workflow-Namen, Status, Tags und vollständige JSON-Strukturen abzurufen. Dient zum dynamischen Aufbau des Index und der Seitenleiste.


• Code n8n Node (Generate Mermaid Chart): Benutzerdefinierte Skripterstellung, die die JSON-Struktur eines Ziel-n8n-Workflows analysiert und einen Mermaid-Diagramm-String generiert, der den Fluss der n8n-Nodes und Verbindungen visuell abbildet.


• Basic LLM Chain (Langchain): Verwaltet den Prozess der Dokumentationsgenerierung. Beinhaltet die Logik für Eingabetext, strenge Anweisungen und die Ausgabeformatierung, um sicherzustellen, dass sich die KI auf die Erstellung nützlicher Inhalte über die n8n-Nodes und deren Konfigurationen konzentriert.


• OpenAI Chat Model (gpt-4-turbo): Die zentrale KI-Komponente, die das Workflow-JSON und die Dokumentationsanweisungen verarbeitet, um umfassende Markdown-Inhalte zu generieren und so die Aufgabe der Dokumentationserstellung zu erfüllen.


• Read/Write File (Load Doc File, Save New Doc File): Kümmert sich um die Persistenz und ermöglicht dem Workflow das Laden bestehender, manuell bearbeiteter Dokumentationen oder das Speichern neu generierter/bearbeiteter Dateien im definierten project_path.


• HTML n8n Node (Main Page, Edit Page): Wird verwendet, um die notwendigen HTML-Seiten zu konstruieren und bereitzustellen. Edit Page enthält das maßgeschneiderte JavaScript für den Live-Markdown-Editor und die Speicherfunktion, was für die Pflege und Bearbeitung der generierten n8n-Vorlagen-Dokumentation entscheidend ist.