> For the complete documentation index, see [llms.txt](https://one-loop.gitbook.io/help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://one-loop.gitbook.io/help/plattform/one-loop-plattform/automatisierung/workflows/workflows-mit-notizen-verstandlich-dokumentieren.md). # Workflows mit Notizen verständlich dokumentieren Notizen erklären, warum ein Workflow existiert und was bei einer Änderung beachtet werden muss. Sie verändern den Ablauf nicht und lösen keine Aktion aus. Ihr Zweck ist Orientierung: Du hältst Wissen direkt dort fest, wo es später gebraucht wird. Es gibt drei unterschiedliche Notizarten. Nutze sie bewusst, damit ein Workflow übersichtlich bleibt. | Notizart | Richtiger Einsatzort | Wofür sie geeignet ist | | ---------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------- | | **Ablaufnotiz** | Seitenleiste des gesamten Workflows | Ziel, Geltungsbereich, wichtige Voraussetzungen und Prüfschritte für den ganzen Ablauf | | **Schrittnotiz** | Direkt an einer einzelnen Aktion oder Bedingung | Warum genau dieser Schritt existiert, welche Eingabe erwartet wird oder welche Ausnahme gilt | | **Haftnotiz** | Sichtbar im Arbeitsbereich des Builders | Kurze Warnung, Checkliste oder Orientierung neben einem Abschnitt des Ablaufs | ## Vor dem Schreiben: Was eine gute Notiz enthält Eine hilfreiche Notiz beantwortet mindestens eine konkrete Frage: * **Was ist das Ziel?** Zum Beispiel: „Bearbeitet eingehende Anfragen und bereitet die Rückmeldung vor.“ * **Warum gibt es diesen Schritt?** Zum Beispiel: „Verhindert, dass eine Nachricht ohne bestätigte Einwilligung versendet wird.“ * **Was muss vor einer Änderung geprüft werden?** Zum Beispiel: „Zuerst mit einem Testkontakt prüfen.“ * **Was passiert bei einer Ausnahme?** Zum Beispiel: „Bei fehlender Telefonnummer endet dieser Zweig.“ Vermeide allgemeine Hinweise wie „Prüfen“ oder „Wichtig“. Sie helfen später nicht weiter. Beschreibe stattdessen die erwartete Prüfung und ihr Ergebnis. ## Die Notizbereiche im Builder finden Öffne den gewünschten Workflow im Builder. In der Seitenleiste befinden sich die Symbole für Statistik, Notizen und Haftnotizen. 1. Klicke auf das **Notizsymbol**, um die Seitenleiste mit Ablauf- und Schrittnotizen zu öffnen. 2. Klicke auf das **Symbol für Haftnotizen**, wenn du eine sichtbare Notiz im Arbeitsbereich anlegen oder ein- und ausblenden möchtest. 3. Wenn ein Symbol oder eine Bearbeitungsmöglichkeit fehlt, prüfe zuerst deine Berechtigung für diesen Workflow. Die Notizbereiche helfen beim Dokumentieren. Sie verändern keine Kontakte, Auslöser oder Aktionen. ## Ablaufnotiz für den gesamten Workflow anlegen Eine Ablaufnotiz beschreibt den Workflow als Ganzes. Sie ist der richtige Ort für Ziel, Voraussetzungen, Verantwortungsbereich und wichtige Ausnahmen. 1. Öffne den Workflow und klicke in der Seitenleiste auf **Notizen**. 2. Klappe den Bereich **Ablaufnotiz** auf. 3. Beschreibe Zweck und Rahmen des Workflows in kurzen Absätzen. 4. Ergänze nur Informationen, die beim Verstehen oder Ändern wirklich nötig sind. 5. Speichere anschließend den Workflow. Die Eingabe zeigt eine Zeichenbegrenzung von bis zu 5.000 Zeichen. Nutze den Platz nicht für ein langes Handbuch: Die wichtigsten Regeln sollen beim Öffnen des Workflows schnell erfassbar sein. Nach dem Speichern zeigt die Notiz, wer sie zuletzt geändert hat und wann das passiert ist. Die Ablaufnotiz wird zusammen mit dem Workflow gespeichert; Änderungen gehen also erst mit dem Speichern des Workflows dauerhaft in die gemeinsame Arbeitsfassung über. ### Vorlage für eine Ablaufnotiz ``` Ziel: [Welches Ergebnis soll der Workflow erzeugen?] Start: [Welches Ereignis oder welche Bedingung startet ihn?] Wichtig vor Änderungen: [Was muss getestet oder geprüft werden?] Ausnahme: [Wann darf der Ablauf nicht weiterlaufen?] Prüfung: [Woran erkennt man ein korrektes Ergebnis?] ``` ## Schrittnotiz direkt an einer Aktion hinterlegen Eine Schrittnotiz erklärt genau eine Aktion, Bedingung oder Verzweigung. Sie steht nicht für den gesamten Ablauf, sondern für die Entscheidung an dieser Stelle. 1. Bewege die Maus über den gewünschten Schritt im Builder. 2. Oben rechts am Schritt erscheint ein Notizsymbol. 3. Klicke auf das Symbol, um den Editor für diesen Schritt zu öffnen. 4. Schreibe die Erklärung in das Textfeld. 5. Klicke auf **Hinzufügen**. 6. Speichere danach den Workflow. Der Editor zeigt die Anzahl der Zeichen und Wörter an. Für die Formatierung stehen sichtbare Grundfunktionen wie Fett, Kursiv und Unterstrichen zur Verfügung. Schreibe trotzdem möglichst kurz: Eine Schrittnotiz soll beim Bearbeiten sofort erklären, was dieser eine Schritt bewirkt. Sobald eine Schrittnotiz vorhanden ist, bleibt ihr Symbol am Schritt sichtbar. Das ist ein wichtiges Signal: Lies die Notiz, bevor du diesen Schritt änderst oder löschst. ## Schrittnotizen zentral prüfen Im Notizbereich der Seitenleiste gibt es zusätzlich den Abschnitt **Schrittnotizen**. Dort kannst du die Notizen der einzelnen Workflow-Schritte gesammelt ansehen und durchsuchen. Öffne diese Übersicht besonders dann, wenn du einen bestehenden Workflow übernimmst: 1. Lies zuerst die Ablaufnotiz für das Gesamtziel. 2. Öffne danach die Übersicht der Schrittnotizen. 3. Suche nach Schritten mit Ausnahmen, Abhängigkeiten oder besonderen Prüfungen. 4. Öffne den passenden Schritt im Builder erst, nachdem du den Hinweis verstanden hast. Zu Schrittnotizen ist ein Verlauf sichtbar. Dadurch lässt sich nachvollziehen, wann Hinweise ergänzt oder verändert wurden. ## Haftnotizen für sichtbare Orientierung verwenden Haftnotizen liegen direkt im Arbeitsbereich. Sie sind hilfreich, wenn ein Abschnitt des Workflows beim ersten Blick erklärt werden muss – etwa vor einer Verzweigung oder neben einer Test-Checkliste. 1. Klicke in der Seitenleiste auf das Symbol für **Haftnotizen**. 2. Wähle eine Farbe aus der sichtbaren Farbauswahl. 3. Die neue Haftnotiz erscheint im Builder. 4. Schreibe eine kurze Überschrift oder Anweisung direkt in die Notiz. 5. Nutze bei Bedarf die Formatierung im Editor. 6. Speichere den Workflow. Der Editor für Haftnotizen bietet Formatierungen wie Fett, Kursiv und Unterstrichen, eine Auswahl für die Schriftgröße, Listen sowie das Einfügen eines Bildes. Nutze Bilder nur, wenn sie eine konkrete Bedieninformation schneller verständlich machen, und prüfe vor dem Speichern, dass keine sensiblen Daten sichtbar sind. ### Farben mit klarer Bedeutung verwenden Lege im Team eine einfache Bedeutung fest und bleibe dabei. Zum Beispiel: | Farbe | Bedeutung im Workflow | | ----- | -------------------------------- | | Gelb | Vor dem Ändern prüfen | | Blau | Erklärung oder Hintergrund | | Grün | Erfolgreich getesteter Abschnitt | | Rot | Warnung oder Ausnahmefall | Die Farben sind nur eine visuelle Ordnung. Entscheidend bleibt der verständliche Text in der Haftnotiz. ## Haftnotizen vorübergehend ausblenden Viele Haftnotizen helfen bei der Übergabe, können aber beim Bearbeiten großer Workflows stören. In der Seitenleiste kannst du sie ausblenden. * Wähle **Notizen ausblenden**, wenn du den Ablauf ohne sichtbare Haftnotizen prüfen möchtest. * Wähle **Notizen anzeigen**, wenn die ausgeblendeten Haftnotizen wieder sichtbar werden sollen. Das Ausblenden entfernt keine Haftnotiz. Es ändert nur, ob sie momentan im Arbeitsbereich angezeigt wird. ## Praxisbeispiel: Einen Rückruf-Workflow übergabefähig machen Ein Workflow verarbeitet Formularanfragen, legt eine Aufgabe an und sendet eine Bestätigung. Damit ein neues Teammitglied ihn sicher übernehmen kann, dokumentierst du ihn so: 1. Ergänze in der Ablaufnotiz das Ziel: „Neue Anfragen werden innerhalb eines Werktags für einen Rückruf vorbereitet.“ 2. Notiere die wichtigste Voraussetzung: „Nur Anfragen mit Telefonnummer laufen in den Rückrufzweig.“ 3. Füge an der Bedingung eine Schrittnotiz hinzu: „Ohne Telefonnummer endet dieser Zweig, damit keine unvollständige Aufgabe entsteht.“ 4. Platziere vor der Versandaktion eine gelbe Haftnotiz: „Nach Textänderungen immer mit Testkontakt prüfen.“ 5. Speichere den Workflow. 6. Öffne den Workflow neu und kontrolliere: Ablaufnotiz sichtbar, Notizsymbol an der Bedingung vorhanden, Haftnotiz lesbar und der Ablauf selbst unverändert. So versteht eine neue Person den Zweck, die Ausnahme und die wichtige Prüfung, ohne den Workflow erst auseinandernehmen zu müssen. ## Häufige Fehler und ihre Lösung ### Ablaufnotiz und Schrittnotiz vermischen Eine Ablaufnotiz erklärt den Gesamtzusammenhang. Eine Schrittnotiz erklärt nur den jeweiligen Schritt. Verschiebe eine lange Erklärung aus einer Schrittnotiz in die Ablaufnotiz, wenn sie für den ganzen Workflow gilt. ### Nach dem Schreiben nicht speichern Die sichtbaren Hinweise werden zusammen mit dem Workflow gespeichert. Klicke nach dem Hinzufügen oder Ändern einer Notiz deshalb auf **Speichern** und prüfe den bestätigten Speicherstatus. ### Haftnotizen als vollständiges Handbuch verwenden Haftnotizen sind für kurze, sichtbare Hinweise gedacht. Teile lange Erklärungen auf: Zusammenfassung in die Haftnotiz, Hintergrund in die Ablauf- oder Schrittnotiz. ### Ein sichtbares Notizsymbol ignorieren Das Symbol am Schritt bleibt sichtbar, wenn dort ein Hinweis hinterlegt ist. Lies ihn vor dem Ändern. Er kann erklären, warum eine scheinbar überflüssige Aktion nötig ist. ### Farben ohne gemeinsame Bedeutung verwenden Wenn jede Person Farben anders nutzt, helfen sie nicht bei der Orientierung. Lege eine einfache Farblogik fest oder verzichte auf Farben, wenn sie keinen Zweck erfüllen. ## Abschlussprüfung * [ ] Die Ablaufnotiz erklärt Ziel, Voraussetzung und Prüfung des gesamten Workflows. * [ ] Jede Schrittnotiz erklärt nur die zugehörige Aktion oder Bedingung. * [ ] Neue Hinweise wurden hinzugefügt und der Workflow wurde gespeichert. * [ ] Haftnotizen sind kurz, lesbar und passend platziert. * [ ] Beim erneuten Öffnen sind Ablaufnotiz, Schrittnotizen und Haftnotizen wie erwartet sichtbar. * [ ] Der Ablauf selbst wurde durch die Dokumentation nicht verändert.