How to write bug report
Agil Bewährte Methoden Verwaltung
15 min lesen
Mai 26, 2022

Erstellen Sie Fehlerberichte, die tatsächlich von Entwicklern gelesen werden

Ein Fehlerbericht ist in der Qualitätsentwicklung das Licht am Ende des Tunnels. Ein gut geschriebener Bericht schont die Nerven der Softwareentwicklungs- und Qualitätssicherungsabteilungen und sie gewinnen Zeit für andere Aufgaben.

photo
Olga Ryan

Ein Fehlerbericht ist in der Qualitätsentwicklung das Licht am Ende des Tunnels. Ein gut geschriebener Bericht schont die Nerven der Softwareentwicklungs- und Qualitätssicherungsabteilungen und sie gewinnen Zeit für andere Aufgaben. Oft ist es jedoch die fehlende Übung im Schreiben von Qualitätsberichten, die für Softwareentwickler und Softwaretester zum Stolperstein wird. Das ist ein heikles Thema für Banken und Fintechs, die sich in der Regel an einem hohen Serviceniveau und maximaler Sicherheit orientieren.

Wir haben Beiträge von mehreren Entwicklern gefunden, die über Probleme bei der Arbeit mit Testfällen schreiben und wie der perfekte Fehlerbericht ihrer Meinung nach aussieht.

photo
Vladislav Zorov, Programmierer

"Versionen der verwendeten Software, Beschreibung der Umgebung (Betriebssystemversion, Browserversion usw.), Schritte zur Reproduktion, erwartetes Verhalten, tatsächliches Verhalten, Protokolldateien, Screenshots, Videodateien usw.
Viele wollen helfen und es ist sicher gut gemeint, aber sie sagen Ihnen, was geändert werden soll, anstatt zu beschreiben, was passiert ist und was sie erwartet haben... das ist manchmal sehr verwirrend, denn die vorgeschlagenen Lösungen sind oft falsch. (Das wissen sie natürlich nicht, weil sie oft nicht mit dem Code vertraut sind.)"

photo
Bill McKissac, beliebter Autor auf Quora.

"Der ideale Fehlerbericht enthält Folgendes:

— Was wurde getan, einschließlich Version und Systemstatus;

— Erwartetes Verhalten der Software;

— Tatsächliches Verhalten der Software;

— Alle Datenanhänge und verfügbaren Protokolldateien;

— Eine Erklärung der Dringlichkeit oder des Fehlens einer solchen. Z. B. ein Jahresbericht ist in Gefahr oder ein Kundenverkauf, oder jemand hat einfach experimentiert;

— Genaue Kontaktinformationen, einschließlich Verfügbarkeit.

Meine Lieblingsantwort ist: "Das Program funktioniert nicht."

Viele Entwickler sprechen von der Notwendigkeit, Probleme zu lösen, die sie nicht haben. Und Fehlerberichte, die zu viele unnötige oder zu wenige Informationen enthalten, erschweren die Arbeit.

😡 Ich habe versucht, den Kontostand in der Anwendung zu überprüfen, aber es funktioniert nicht richtig. Können Sie überprüfen, ob etwas nicht in Ordnung ist?

😡 Ich kann den Saldo in der Anwendung nicht überprüfen.

Es ist unklar, welche Aktivitäten des Testers zu diesem Ergebnis geführt haben, ob es sich um einen echten Software-Fehler oder nur um menschliches Versagen handelt und welche Ergebnisse die Tester von der Anwendung erwartet haben. Keines dieser Beispiele hilft den Entwicklern, ein Problem zu lösen. Es ist fantastisch, dass ein Tester einen Fehler gefunden hat, aber eine unsachgemäße Dokumentation macht diese Entdeckung nutzlos.

Wie sieht der perfekte Fehlerbericht aus?

Ein Fehlerbericht ist ein Dokument der Tester, in dem detailliert beschrieben wird, welche Fehler bei der Verwendung des Produkts aufgetreten sind und welche Korrekturen erforderlich waren. Fehlerberichte können mithilfe verschiedener Services und Plattformen wie Trello oder Excel erstellt werden. Die Berichte sind einfach und können zusammengefasst an das Entwicklerteam gesendet werden. Es gibt jedoch auch fortschrittlichere Plattformen wie Jira oder aqua ALM, die über umfangreiche Funktionen verfügen. Dadurch werden Ihre Berichte detaillierter und effektiver.

Excel

Fehlerbericht in einer Excel-Registerkarte

Test case

aquas Testfälle und Fortschrittsvisualisierung

Welche Instrumente Sie für das Schreiben eines Fehlerberichts auch wählen, es gibt bestimmte Komponenten, die Ihren Bericht erheblich verbessern und informativer machen.


Sie können sich diese Komponenten mit Hilfe des Akronyms PEOPLEProblem, Example, Oracle, Platform, Literate, Extrapolate einprägen (Problem, Beispiel, Orakel, Plattform, Schreiben, Extrapolieren):

Problem (Problem) — Beschreiben Sie das Problem so klar und prägnant wie möglich;

Example (Beispiel) — Bieten Sie Ihrem Team Erholungsmaßnahmen an, als wären Sie gerade erst zum Team gestoßen;

Oracle (Orakel) — Nennen Sie einige Gründe, warum Sie das als Fehler bewerten;

Platform (Plattform) — Geben Sie Details zur Umgebung an;

Literate (Schreiben) — Erzählen Sie Geschichten, verwenden Sie eine korrekte Rechtschreibung und Grammatik, damit der Bericht erzählerisch und verständlich ist;

Extrapolate (Extrapolieren) — Erkunden und erläutern Sie, was sonst noch mit demselben Fehler zusammenhängt und von ihm betroffen sein könnte.


Sie können auch eine Fehlerumgehung oder eine Lösung dafür finden, falls es möglich ist. Diese Komponenten helfen Ihnen, Ihren Fehlerbericht informativ und einfach zu gestalten. Sehen wir uns jetzt die ideale Struktur eines Fehlerberichts an.

Titel

Halten Sie den Titel kurz und bündig. Wenn der Titel kürzer als 100 Zeichen ist, ist er angemessen. Füllen Sie Ihren Titel ggf. mit Schlüsselwörtern, damit Entwicklern einen gesuchten Fehlerbericht schnell finden.

😡 Bringt das so schnell wie möglich in Ordnung, denn ich versuche gerade, eine Bankverbindung einzugeben, aber es wird nichts gespeichert. Ich weiß nicht, warum mit diesem Feld etwas nicht in Ordnung ist.

😁 Transaktionsfeld in der Web-Version – ein unbekannter Fehler tritt beim Einfügen von Bankdaten auf

Der Titel muss dem Entwickler auf den ersten Blick zeigen, ob dieser Fehler dringend ist und sofort behoben werden muss und ob es sich überhaupt lohnt, den Rest des Berichts zu lesen.

Zusammenfassung

Manchmal benötigen Entwickler weitere Informationen darüber, wie es zu dem Fehler gekommen ist. In diesem Fall wäre es hilfreich, eine kurze Zusammenfassung des Berichts hinzuzufügen. Die Zusammenfassung und der Titel spielen bei Suchanfragen eine Rolle, es ist aber auch wichtig, die Schlüsselwörter in den Textkörper aufzunehmen. Wenn Sie eine Gliederung schreiben, sollten Sie auflisten, was zuerst passiert ist und was die Ursache dafür war.

😡  Ich habe dreimal auf die Schaltfläche geklickt, in der Hoffnung, dass die Details in das Feld eingefügt werden, aber es passierte nichts. Ich habe es auch am nächsten Tag versucht, aber die Transaktionsfunktion funktioniert weiterhin nicht und zeigt einen Fehler an.

😁  Die Funktion „Transaktion“ in der Web-Version fügte keine Bankdaten in das Feld „Transaktionsdetails“ ein, wenn man auf die Schaltfläche „Bankdaten einfügen“ klickt. Bei mehrfachem Klicken der Schaltfläche wurde das Popup-Fenster „Unbekannter Fehler aufgetreten“ angezeigt.

Visueller Beweis

Eine gute Beschreibung ist für Entwickler wertvoll, aber ein Bild kann mehr Informationen zu dem beschriebenen Fehler liefern. Beschreiben Sie zum Beispiel, wie Ihr Freund aussieht, und zeigen Sie dann sein Foto. Ihr Begleiter wird sich diesen speziellen Freund merken und von allen anderen Freunden unterscheiden.

Ein visueller Beweis kann ein Screenshot oder ein Video sein, die dazu beitragen, dass der Entwickler das Problem schneller findet.

Visual proof of a defect in aqua

Visueller Nachweis eines Mangels in aqua

Das Hinzufügen von visuellen Nachweisen ist eine großartige Funktion, die in Excel nicht immer verfügbar ist. Trello ist in dieser Hinsicht viel einfacher, erfüllt aber noch nicht zu 100 % die Anforderungen an die Benutzerfreundlichkeit für Entwickler. Für diese Zwecke ist aqua genau das Richtige für Tester. Es bietet die Möglichkeit, visuelle Beweise direkt in die Beschreibung unter dem Fehlerbericht einzufügen und sie ohne Grafikbearbeitungstools von Drittanbietern zu bearbeiten.

Lernen Sie, wie Sie die besten Fehlerberichte in aqua erstellen

AQUA DEMO BUCHEN

Erwartete und tatsächliche Ergebnisse

Beim Testen wird immer versucht, die Seite des Benutzers einzunehmen. Was möchte er bei einer bestimmten Aktion in der Anwendung, auf der Website oder in Ihrem Programm erreichen? Das ist eine hervorragende Aufforderung, die richtigen erwarteten und tatsächlichen Ergebnisse zu beschreiben. Der Benutzer wollte die Transaktion durch Anklicken einer Schaltfläche durchführen, aber nichts geschah. Das ist fast eine gute Beschreibung für Entwickler. Es muss das Ziel sein, dem Entwickler durch kurze und prägnante Informationen zu vermitteln, was Sie erwartet haben und was tatsächlich passiert ist.

😡  Erwartetes Ergebnis: Die Schaltfläche „Bankverbindung einfügen“ funktioniert einwandfrei.

😡  Tatsächliches Ergebnis: Die Schaltfläche „Bankverbindung einfügen“ funktioniert überhaupt nicht.

😁  Erwartetes Ergebnis: Die Bankdaten sollten im Feld „Transaktionsdetails“ hinzugefügt werden, wenn Sie auf die Schaltfläche „Bankdaten einfügen“ klicken.

😁  Tatsächliches Ergebnis: Das Feld „Transaktionsdetails“ bleibt leer und die Seite wird automatisch neu geladen.

Schritte zur Reproduktion

Es gibt zwei Meinungen über die Beschreibung von Schritten, die Entwicklern helfen sollen, den Pfad zu reproduzieren, auf dem Sie einen Fehler gefunden haben. Manche Entwickler ziehen es vor, es als erzählte Geschichte zu lesen, andere wiederum als einen Schritt-für-Schritt-Algorithmus. Man weiß nie, welcher Entwickler sich um einen beschriebenen Fehler kümmert, daher ist es besser, zwei Fliegen mit einer Klappe zu schlagen.

Das Wichtigste dabei ist, die Schritte kurz und verständlich zu beschreiben.

😡  Hauptseite >>> Transaktionsseite >>> Feld „Transaktionsdetails“ >>> Schaltfläche „Bankverbindung einfügen“ >>> Keine Änderung

😡  Also beschloss ich, die Transaktionsseite in meinem Kundenskonto zu testen. Ich bin zuerst auf die Hauptseite gegangen und habe micht dann etwa zwei Minuten bei meinem Profil angemeldet. Dann habe ich die Transaktionsseite geöffnet. Alles funktionierte gut, bis ich beschloss, die Transaktionsfunktion selbst zu überprüfen. Ich wählte das Feld Transaktionsdetails und klickte auf die Schaltfläche „Bankdaten einfügen“. Es hat nicht geklappt, also habe ich es noch einmal versucht. Wieder wurde nichts eingefügt, und die Seite wurde plötzlich aktualisiert.

Im ersten Beispiel erfahren wir den Weg, aber keine Informationen zu den Aktionen. Das zweite Beispiel strukturiert nicht den direkten Weg und liefert unvollständige und unverständliche Informationen, die auch für Entwickler schwer zu verstehen sind. Versuchen Sie stattdessen, reproduzierende Schritte auf direktem Weg zu beschreiben:

Umgebung

Berücksichtigen Sie auch Aspekte der Umgebung, die Sie getestet haben:

Fügen Sie die Reproduzierbarkeitsquote in Ihren Bericht ein, wenn Sie es mehrmals versucht haben und ein Problem weiterhin besteht. Zum Beispiel, das Problem tritt in fünf von fünf Testläufen auf.

Auch wenn wir uns in diesem Artikel auf eine finanzielle Nische konzentrieren, sind detaillierte Informationen zu Geräten und Umgebungen auch für Hersteller und Warenproduzenten unerlässlich.

In aqua können finden Sie beispielsweise benutzerdefinierte Felder, Kennzeichnungen, Variablen wie den Gerätetyp, die Umgebungen, in denen sie getestet werden, Parametrisierung für effizientes Testen mit verschiedenen Daten, Bestimmung der Testausführungszeit, Verfolgung der Zeit, wie lange die Testdurchführung dauert, Organisation des Prozesses durch eine Hierarchie von Projekten und Ordnern, in denen verschiedene Arten von Hardware und Software getestet werden.

Erkunden Sie die Funktionen von aqua, um bessere Fehlerberichte zu erhalten

MEHR LERNEN

Konsolenprotokolle

Befehle, die die Fehlerbehebung um ein Vielfaches beschleunigen können sind „C + Shift + Command“ für macOS oder „Ctrl + Shift + C“ für Windows.

Abstürze oder aufgetretene Fehler sind manchmal schwer zu reproduzieren. Deshalb können Informationen aus Konsolenprotokollen wertvoll sein. Sie vermitteln ein Gesamtbild und helfen den Entwicklern, die Ursache eines Problems schneller zu erkennen.

URL der Quelle

Ein unterhaltsamer Fakt zu Fehlerberichten: Der häufigste Fehler beim Schreiben ist, dass man vergisst, einen Link zu der Seite hinzuzufügen, auf der man einen Fehler gefunden hat.

Schweregrad und Priorität

Sie sollten zwei Kriterien verwenden, um die Dringlichkeit eines gefundenen Fehlers zu bewerten – Schweregrad und Priorität.

Um den Schweregrad eines Fehlers zu bestimmen, müssen Sie berücksichtigen, welche Auswirkungen er haben kann, wenn er weiterhin auftritt, oder ob er eine potenzielle Bedrohung für das System darstellt. Es gibt verschiedene Schweregrade: gering, leicht, schwer, kritisch.

Die Priorität gibt an, wie schnell dieser Fehler behoben werden muss, bevor er die Funktionalität des Produkts beeinträchtigt. Im Grunde zeigt sie die Dringlichkeit, diesen Fehler loszuwerden. Es gibt vier Prioritäten: niedrig, mittel, hoch, sofort.

Optional

Sie können auswählen, wo und wie Sie Ihre Fehlerberichte registrieren. Manche glauben, dass Excel das beste System zur Fehlerverfolgung ist, andere verwenden speziell entwickelte Anwendungen, und kleinere Teams nutzen manchmal sogar Instant Messenger. Erfahrene Tester und Entwickler sind sich jedoch einig, dass ein professioneller Tracker für diese Zwecke eine echte Erleichterung sein kann.


Kirill Chabanov, COO von aqua cloud ALM und ehemaliger Tester, bietet seine perfekte Fehlerberichtsstruktur an, die er verwendet hat:

photo
Kirill Chabanov

1) strukturiert (genau wie diese Liste)
2) kurz gefasst, nichts Unnötiges
3) nach Möglichkeit Screenshots


Einige Fehlerverfolgungssysteme ermöglichen es Ihnen, eigene Vorlagen für das Schreiben von Fehlerberichten zu erstellen, was die Arbeit für Entwickler erheblich vereinfacht. In aqua zum Beispiel kann jedes Team eine eigene Vorlage erstellen, damit diese Informationen bereits hinterlegt wurden und für alle gleich sind, wenn man einen Fehler beginnt. Außerdem können Sie einen eindeutigen Arbeitsablauf festlegen. Solange Sie nicht alle erforderlichen Felder ausgefüllt haben, kann der Fehlerbericht nicht erstellt werden.

Error validation in aqua

Fehlervalidierung in aqua

Schlussfolgerung

Die Kosten für die Behebung eines Fehlers, der in die Produktion gelangt, sind 150 Mal höher als die Kosten für seine Vermeidung. Das ist eines der Hauptargumente für den Einsatz von Programmen zur gründlichen Fehlerverfolgung. Im Finanz- und Bankensektor äußern sich Fehler bei der Entwicklung (insbesondere in Bezug auf Sicherheit und Datenschutz) unter anderem in monetären Kosten und Reputationsverlusten. Wie viele von uns wissen, ist das für die behördliche Zulassung von entscheidender Bedeutung. Daher ist es unerlässlich, eine Qualitätssicherung einzuführen und das Schreiben detaillierter Fehlerberichte für alle an der Entwicklung Beteiligten zu vereinfachen.

Verbessern Sie Ihren Prüfprozess mit aqua

KONTAKT US
On this page:
See more
Beschleunigen Sie Ihre Releases x2 mit aqua ALM
Gratis starten
FAQ
Was ist mit Fehlerbericht gemeint?

Ein Fehlerbericht ist eine schriftliche Zusammenfassung eines Software-Stabilitätsproblems. Darin wird in der Regel das Problem beschrieben, wo es aufgetreten ist und wie es reproduziert werden kann.

Nach welchem Prinzip wird ein zusammenfassender Fehlerbericht geschrieben?

Das mnemonische Akronym PEOPLE stellt die Regeln für Fehlerberichte gut dar: Problem, Beispiel, Oracle, Plattform, Schreiben, Extrapolieren.

Wie wird ein Fehlerbericht erstellt?

Fehlerberichte werden in der Regel an eine Lösung zur Fehlerverfolgung übermittelt. Die besten Tools, wie beispielsweise aqua, bieten Vorlagen an, um den QS-Spezialisten Zeit zu sparen und/oder Nichttechniker mit einem einfacheren Format einzubeziehen.

closed icon