Automatisierung der Dokumentation mit KI: Ein Leitfaden für QA-Ingenieure

Das Schreiben von Dokumentationen, wie Testfällen und Checklisten, kann für QA-Ingenieure eine mühsame und zeitaufwändige Aufgabe sein. Während das Testen von APIs, die Analyse des UI-Verhaltens und das Finden von Fehlern ansprechend sein können, führt die repetitive Natur der Dokumentation oft zu Ermüdung und dem Wunsch nach einer effizienteren Lösung. Dieser Artikel untersucht, wie KI diesen Schmerz lindern kann.

Der erste Schritt besteht darin, der KI eine klare Aufgabendefinition zu geben. Dies kann durch Hochladen eines Screenshots des betreffenden Bildschirms oder durch Beschreibung der Funktionalität, für die eine Checkliste benötigt wird, erfolgen. Zusätzlicher Kontext, wie z. B. wo der Bildschirm verwendet wird, die verfügbaren Steuerelemente und das erwartete Verhalten, kann das Verständnis der KI weiter verbessern. Die KI generiert dann einen ersten Entwurf der Checkliste, der typischerweise grundlegende Prüfungen wie Schaltflächenanzeige, Klickreaktion und Bildschirmübergänge abdeckt. Obwohl diese anfängliche Ausgabe möglicherweise nicht perfekt ist, dient sie als wertvoller Ausgangspunkt.

Hier beginnt der iterative Prozess. Die von der KI generierte Checkliste wird überprüft und Feedback gegeben, um etwaige Mängel zu beheben. Häufige Probleme sind das Vergessen von 'Zurück'- und 'Schließen'-Schaltflächen, das Nichtunterscheiden zwischen Überschriften und interaktiven Elementen, das Ignorieren des Icon-Verhaltens und das Übersehen nicht standardmäßiger Muster. Spezifisches Feedback wird gegeben, um die KI anzuleiten, oft mit detaillierter Beschreibung des gewünschten Ergebnisses. Durch mehrere Iterationen passt sich die KI an und liefert eine verfeinerte Ausgabe, die für den praktischen Einsatz bereit ist.

Sobald der Inhalt der Checkliste zufriedenstellend ist, wird die KI angewiesen, ihn gemäß spezifischen Anforderungen zu formatieren. Dies kann die Definition von Zerlegungsstufen (Abschnitte und Schritte), die Nummerierung jedes Elements, die Anwendung eines bestimmten Schreibstils und die Strukturierung der Daten mit Feldern wie ID, Bildschirm, Erwartetes Ergebnis, Priorität und Verhalten umfassen. Um sicherzustellen, dass die KI das gewünschte Format versteht, kann eine Vorlage oder eine PDF-Datei mit den Anforderungen als Referenz bereitgestellt werden. Beispiele für korrekte und falsche Formatierungen können ebenfalls gegeben werden, um die Erwartungen weiter zu verdeutlichen.

Der nächste Schritt besteht darin, Metadaten und Attribute hinzuzufügen, die die KI möglicherweise nicht automatisch einschließt. Dies können Priorität (Hoch/Mittel/Niedrig), Verhaltenstyp (Positiv/Negativ), Komponente (für Modulverknüpfung) und Links zu Anforderungen sein. Wenn die KI eines dieser Attribute weglässt, werden explizite Anweisungen oder Beispiele gegeben, um ihr Verhalten zu steuern. Visuelle Hilfsmittel, wie z. B. Screenshots, die die gewünschte Ausgabe zeigen, können ebenfalls wirksam sein.

Sobald die Checkliste den erforderlichen Standards entspricht, wird sie in ein Format exportiert, das mit Testmanagement-Systemen kompatibel ist. CSV ist ein besonders praktisches Format, da die KI eine Tabelle generieren kann, bei der jede Zeile eine separate Prüfung darstellt und alle Felder in der richtigen Reihenfolge für den Import in Tools wie TestRail, Qase oder Allure TestOps stehen. Andere Formate wie Markdown oder JSON können je nach Ziel der Dokumentation ebenfalls verwendet werden.

Die anfängliche Einrichtung und das Training der KI können etwa 40 Minuten dauern. Sobald die KI jedoch trainiert und der Dialog gespeichert ist, können nachfolgende Aufgaben 3-5 Mal schneller erledigt werden. Es ist entscheidend, die Sitzung, in der die Iterationen durchgeführt wurden, beizubehalten, da sie als Arbeitsumgebung dient, in der sich die KI an den etablierten Stil, die Struktur und die Anforderungen erinnert.

Es ist wichtig zu erkennen, dass KI selten auf Anhieb perfekte Ergebnisse liefert. Jeder Schritt erfordert einen Zyklus aus Lesen, Korrigieren, Verfeinern und Vergleichen mit den Erwartungen. Blindes Vertrauen in KI ist nicht ratsam, da sie ein hilfreiches, aber unvollkommenes Werkzeug ist. Ein solides Verständnis dessen, was ein gutes Ergebnis ausmacht, ist unerlässlich, um Fehler zu erkennen. Daher eignet sich KI am besten für diejenigen, die bereits über die Fähigkeiten verfügen, Dokumentationen manuell zu schreiben. Vorlagen sollten an die spezifische Aufgabe angepasst werden, und neue Projekte erfordern möglicherweise Anpassungen. Rechtliche Risiken sollten ebenfalls berücksichtigt werden, und sensible Informationen sollten unter NDAs anonymisiert werden.

Wenn das Schreiben von Dokumentationen wie eine herausfordernde Aufgabe erscheint, sollten Sie erwägen, KI auszuprobieren. Obwohl eine anfängliche Einrichtung erforderlich ist, kann sie sich in ein wirklich nützliches Werkzeug verwandeln. Für diejenigen, die KI bereits im Testing einsetzen, kann das Teilen von Tipps und Tricks den Übergang der Branche von manuellen Prozessen zu einem stärker automatisierten und effizienteren Ansatz beschleunigen.