Einsatz WSKI für die Dokumentation

Einsatz WSKI für die Dokumentation

von Domenico Milazzo -
Anzahl Antworten: 2
Nutzerbild von Gruppenchat KITE Start: 04.07.25

Hallo zusammen,

ich schreibe oft meine Dokumentationen mit ChatGPT oder Perplexity ich wollte benutzte nun dieses mal die WSKI weil ich befürchte das ich damit die Texte leserlicher und verständlicher hinbekommen.

Als Prompt hab ich den Super-Prompt aus Modul 1 Lyra verwendet mir einen Dokumentationsauschnitt zu schreiben über "Implementierung einer Statusmaschine in NodeRed"

Hier das Ergebnis, bin auf eurer Feedback gespannt.

ChatGPT

Die Implementierung einer Statusmaschine mit Node-RED ermöglicht eine transparente und flexible Abbildung von zustandsbasierten Abläufen, wie sie häufig in Automatisierungs- oder Steuerungsanwendungen benötigt werden. In meinem Anwendungsfall bestand die Aufgabe darin, einen Prozess mit klar definierten Zuständen und Übergängen abzubilden – etwa IDLE, RUNNING und ERROR – wobei jede Zustandsänderung durch bestimmte Ereignisse wie Start, Fehler oder Reset ausgelöst wurde.
Node-RED erwies sich dabei als besonders geeignet, da es eine visuelle Programmierumgebung bietet, die logisch nachvollziehbar und leicht wartbar ist. Die Zustandsverwaltung erfolgt über den Flow-Kontext (flow. status), sodass der aktuelle Status jederzeit abrufbar und änderbar bleibt. Mit einfachen switch-Abfragen innerhalb von Function-Nodes konnte ich die Übergangslogik der Statusmaschine definieren. Dabei wird geprüft, welcher Status aktuell aktiv ist und ob das eingehende Ereignis einen zulässigen Übergang erlaubt. Erfolgt ein Wechsel, wird der neue Status gesetzt und optional eine Rückmeldung generiert.
Zusätzlich kamen Switch-Nodes zur Weichenstellung je nach Eingabewert, sowie Change-Nodes zum gezielten Ändern von Kontextvariablen zum Einsatz. Für Tests und Debugging nutzte ich Inject- und Debug-Nodes, um den Statusverlauf gezielt nachvollziehen zu können. Eine Besonderheit war die Nutzung des persistenten Kontextes in Node-RED, wodurch auch nach einem Neustart der zuletzt aktive Zustand erhalten blieb – ein entscheidender Faktor für den Einsatz in realen Szenarien.
Ein praktisches Beispiel war die Modellierung einer einfachen Drei-Zustands-Maschine: Vom Zustand IDLE konnte durch ein Start-Ereignis zu RUNNING gewechselt werden. Ein Fehlerereignis führte dann in den ERROR-Zustand, aus dem durch einen Reset wieder zu IDLE zurückgekehrt werden konnte. Diese Logik ließ sich klar abbilden und später bei Bedarf erweitern – etwa durch zusätzliche Zustände wie PAUSED oder MAINTENANCE.
Die Vorteile dieser Methode liegen in der Modularität, Klarheit und einfachen Erweiterbarkeit. Zudem lassen sich alle Zustände visuell darstellen und über Dashboards live überwachen. Die Umsetzung war insgesamt intuitiv und gut dokumentierbar. Für komplexere Anwendungen empfiehlt es sich, die Zustandslogik in einem separaten Subflow zu kapseln, um Wiederverwendbarkeit und Übersichtlichkeit zu gewährleisten.
Abschließend lässt sich sagen: Node-RED ist hervorragend geeignet, um Statusmaschinen auch ohne tiefere Programmierkenntnisse systematisch zu entwickeln. Die Kombination aus visueller Logik und JavaScript-Flexibilität bietet einen idealen Einstieg in zustandsorientierte Steuerungen.

WSKI

Mit Node-RED lässt sich eine Statusmaschine transparent und flexibel umsetzen – ideal für Automatisierungs- oder Steuerungsanwendungen. In meinem Fall galt es, einen Prozess mit klar definierten Zuständen und Übergängen abzubilden, etwa IDLE, RUNNING und ERROR. Zustandswechsel wurden durch Ereignisse wie Start, Fehler oder Reset ausgelöst. 

Node-RED erwies sich als besonders geeignet, da es eine visuelle Programmierumgebung bietet, die logisch nachvollziehbar und leicht zu warten ist. Die Zustandsverwaltung erfolgt über den Flow-Kontext (flow. status), sodass der aktuelle Status jederzeit abrufbar und änderbar bleibt. Mit einfachen Switch-Abfragen in Function-Nodes definierte ich die Übergangslogik: Der aktive Status wird geprüft, das eingehende Ereignis bewertet und bei einem zulässigen Wechsel der neue Status gesetzt. Optional generiert das System eine Rückmeldung. 


Zusätzlich nutzte ich Switch-Nodes, um Eingabewerte zu filtern, und Change-Nodes, um Kontextvariablen gezielt zu ändern. Inject- und Debug-Nodes halfen beim Testen und Nachvollziehen des Statusverlaufs. Besonders nützlich war der persistente Kontext von Node-RED, der den zuletzt aktiven Zustand auch nach einem Neustart bewahrt – ein entscheidender Vorteil für reale Anwendungen. 

Ein Beispiel: Eine einfache Drei-Zustands-Maschine. Von IDLE wechselt der Prozess durch ein Start-Ereignis zu RUNNING. Ein Fehlerereignis führt in den ERROR-Zustand, aus dem ein Reset zurück zu IDLE führt. Diese Logik ließ sich klar abbilden und bei Bedarf erweitern, etwa um Zustände wie PAUSED oder MAINTENANCE. 

Die Methode überzeugt durch Modularität, Klarheit und einfache Erweiterbarkeit. Zustände lassen sich visuell darstellen und über Dashboards live überwachen. Die Umsetzung war intuitiv und gut dokumentierbar. Für komplexere Anwendungen empfiehlt es sich, die Zustandslogik in einem separaten Subflow zu kapseln, um Übersichtlichkeit und Wiederverwendbarkeit zu gewährleisten. 

Fazit: Node-RED eignet sich hervorragend, um Statusmaschinen systematisch zu entwickeln – auch ohne tiefere Programmierkenntnisse. Die Kombination aus visueller Logik und JavaScript-Flexibilität bietet einen idealen Einstieg in zustandsorientierte Steuerungen.

687 Wörter

Als Antwort auf Domenico Milazzo

Re: Einsatz WSKI für die Dokumentation

von Judith Friedrich -
Nutzerbild von Gruppenchat KITE Start: 04.07.25
Ich finde die Textstrukturierung von WSKI besser. Für mich als Leihe in dem Thema war der Text von WSKI dadurch deutlich leichter zu lesen. Interessant wäre noch, wie der Text von ChatGPT sich verändern würde, wenn man anfangs durch einen gezielten Prompt, z.B. eine einfache Lesbarkeit fordert.

47 Wörter

Als Antwort auf Domenico Milazzo

Re: Einsatz WSKI für die Dokumentation

von Milena Droste -
Nutzerbild von Gruppenchat KITE Start: 04.07.25
Lieber Domenico,

vielen Dank für deinen praxisnahen Beitrag und deinen Einblick in die Dokumentationsarbeit mit verschiedenen KI-Tools. Deine Entscheidung, die WSKI gezielt im Vergleich zu ChatGPT einzusetzen, ist nachvollziehbar und fachlich sehr sinnvoll gewählt, gerade wenn du auf eine bessere Lesbarkeit und Verständlichkeit deiner technischen Dokumentation abzielst.

Besonders positiv fällt auf, dass du für den Vergleich den gleichen Textinhalt verwendet und beide Versionen strukturiert und gut nachvollziehbar präsentiert hast. Die Themenwahl, die Implementierung einer Statusmaschine in Node-RED, ist ein technisches Szenario mit klarer Anforderung an Verständlichkeit, was sich hervorragend für diesen Vergleich eignet.

Dein ChatGPT-Text überzeugt durch eine dichte, inhaltlich sehr fundierte Darstellung. Er zeigt ein hohes Maß an Fachwissen und reflektiert deine Erfahrung mit Node-RED. Der Text ist sehr ausführlich, geht in die Tiefe und wirkt wie eine kleine Fachpublikation. Besonders stark ist deine Argumentation zur Modularität und zur Nutzung des persistenten Kontextes. Auch deine Empfehlung zur Kapselung der Logik in einem Subflow ist ein wertvoller Praxistipp.

Die mit der WSKI generierte Version wirkt klarer strukturiert und sprachlich etwas zugänglicher. Die Sätze sind kompakter, der Text wirkt insgesamt flüssiger und ist wahrscheinlich auch für Leser ohne tiefere Vorkenntnisse leichter zu erfassen. Dass die WSKI deinen Stil und Inhalt gut aufgreift und zugleich sprachlich glättet, zeigt, dass sie ihrem Zweck hier gerecht wird. Du hast damit sehr schön herausgearbeitet, wo der Nutzen in der Tool-Auswahl je nach Zielgruppe und Kommunikationssituation liegen kann.

Besonders gelungen ist auch dein Einstieg, in dem du offen formulierst, mit welchem Ziel du die WSKI getestet hast. Das macht deinen Erfahrungsbericht authentisch und nachvollziehbar. Es wäre spannend, wenn du künftig noch gezielter die Unterschiede in Sprachebene, Satzstruktur und technischer Präzision zwischen den Tools analysierst. Du hast auf jeden Fall ein gutes Gespür dafür.

Insgesamt ist dein Beitrag ein sehr gelungenes Beispiel für die Nutzung von KI-Tools zur Optimierung technischer Fachtexte. Deine differenzierte Reflexion sowie dein praxisnahes Beispiel bieten einen echten Mehrwert für alle, die KI im technischen Kontext einsetzen möchten. Sehr überzeugend.
Viele Grüße!

328 Wörter