Die Zeichnung allein reicht nicht
Ein Workflow mit vielen verbundenen Kästchen zeigt die technische Struktur. Für die tägliche Arbeit fehlen darin oft die entscheidenden Informationen: Welcher Ordner löst den Ablauf aus? Wer prüft unvollständige Daten? Darf nach einem Abbruch erneut gestartet werden?
Beginnen Sie die Dokumentation mit einem kurzen Steckbrief. Er nennt Zweck, Auslöser, Eingaben, Ergebnis und verantwortliche Person. Jemand außerhalb des Projekts sollte daran erkennen, ob der Ablauf für einen konkreten Vorgang zuständig ist.
Zugang und Geheimnisse getrennt behandeln
Die Dokumentation darf beschreiben, welches technische Konto verwendet wird und wer es verwaltet. Passwörter und API-Schlüssel gehören in einen dafür vorgesehenen sicheren Speicher. Ein Bildschirmfoto mit sichtbarem Schlüssel macht eine ansonsten gute Anleitung unnötig riskant.
Notieren Sie, welche Berechtigungen erforderlich sind. Wenn später ein Zugang erneuert wird, kann die Betreuung damit denselben Umfang herstellen, ohne vorsorglich Vollzugriff zu vergeben.
Den Störungsfall vorführen
Bei der Übergabe sollte eine zuständige Person einen offenen Vorgang finden und den vorgesehenen Ersatzweg durchführen. Dazu gehört auch der Unterschied zwischen einem sicher fehlgeschlagenen Schritt und einem unklaren Ergebnis im Zielsystem.
Die n8n-Dokumentation beschreibt die Auswertung fehlgeschlagener Ausführungen und Fehlerworkflows. Technischer Ausgangspunkt. Ihre Betriebsanleitung ergänzt die fachliche Entscheidung: Wer klärt den Fall und wann gilt er als erledigt?
Diese Unterlagen sollten zusammenpassen
- Ablaufbeschreibung mit Systemen und Datenwegen.
- Liste der Zuständigkeiten einschließlich Vertretung.
- Abnahmetests und bekannte Grenzen.
- Anleitung zum Stoppen und kontrollierten Wiederanlauf.
- Änderungsprotokoll mit der eingesetzten Version.
- Regel für Sicherung und Wiederherstellung.
Verlinken Sie die aktuelle Fassung von einer gemeinsamen Startseite. Mehrere widersprüchliche Anleitungen in verschiedenen Ordnern erschweren gerade im Störungsfall die Arbeit.
Eine Änderung ist erst mit Dokumentation fertig
Wenn ein neues Feld hinzukommt, betrifft das möglicherweise Prüfung, Ausgabe und Fehlermeldungen. Aktualisieren Sie diese Stellen zusammen. Ein Datum allein genügt nicht; ein kurzer Änderungsvermerk sollte erklären, welche Auswirkung die neue Version hat.
Testen Sie die Übergabe mit jemandem, der den Ablauf nicht gebaut hat. Findet diese Person den richtigen Vorgang und kann sie einen einfachen Fehler bearbeiten, ist die Anleitung brauchbar. Muss der ursprüngliche Entwickler jede Frage beantworten, fehlen noch Informationen. Das gilt auch bei kleinen Automatisierungen, die zunächst nur wenige Minuten pro Woche sparen.
Quellen und weiterführende Grundlagen
Über den Autor
Julian Süllner hat Provehor gegründet und führt das Unternehmen als Geschäftsführer. Er verantwortet Produktentwicklung, Kundenprojekte und die Ratgeber auf dieser Website.