Wie Schreibt man einen Guten Fehlerbericht? Beste Praktiken

Fehlerverfolgung, -meldung und -behebung sind integrale Prozesse in der Softwareentwicklung. Von all diesen Aufgaben scheint das Berichten die am wenigsten wichtige zu sein, aber das ist nicht der Fall. Je besser der Bericht ist, desto schneller wird der Fehler behoben. Wenn der Bericht jedoch nicht alle wichtigen Details enthält oder dies auf die falsche Art und Weise tut, wird die Behebung des Fehlers mehr Zeit, Mühe und Geld kosten.

Wir haben die effizientesten Praktiken zur Fehlerberichterstattung zusammengestellt, die für neue QA-Tester nützlich sein werden.

Wie schreibt man einen Fehlerbericht? Beste Beispiele und Praktiken

Sie haben einen Fehler entdeckt, also ist Ihr nächster Schritt, ihn zu melden. Hier sind die Empfehlungen für die Erstellung eines effektiven Fehlerberichts.

Geben Sie alle wesentlichen Details an

Ein guter Fehlerbericht muss enthalten:

Fehler Nummer

Jeder Bericht sollte eine eindeutige Fehler-ID haben – sie wird verwendet, um auf ein bestimmtes Problem zu verweisen, wenn es diskutiert, priorisiert und behoben wird. Wenn Sie ein automatisiertes Bug-Reporting-Tool (oder etwas Universelleres wie Jira) verwenden, wird die Nummer automatisch erstellt und Ihrem Bericht hinzugefügt.

Titel

Ein Titel sollte kurz erklären, was falsch ist. Zum Beispiel: “Die Schaltfläche “Kontakt” funktioniert nicht”. Anhand des Titels kann sich Ihr Team einen Überblick über das Problem verschaffen und verstehen, ob es schon früher aufgetreten ist.

Umgebung

Wenn Sie die Umgebung nicht angeben, ist es möglicherweise unmöglich, den Fehler zu reproduzieren. Zum Beispiel haben Sie einen Fehler in der iOS-Version der App entdeckt. Dann hat ein Entwickler versucht, ihn in der Android-Version zu reproduzieren, aber es passierte nichts – alles funktionierte einwandfrei. Solche Situationen sind möglich, daher sollten Sie immer Details über die Umgebung angeben. Dazu können folgende Angaben gehören:

• – Gerät (geben Sie das genaue Modell an)
• – Betriebssystem und dessen Version
• – Verwendetes Konto
• – App-Version
• – Browser und seine Version
• – Art der Verbindung

Schritte zum Reproduzieren

Jeder Fehler sollte reproduzierbar sein, sonst kann er nicht behoben werden. Beschreiben Sie daher bei der Erstellung Ihres Berichts Schritt für Schritt, welche Aktionen zum Auftreten des Fehlers führen. Lassen Sie nichts aus, auch nicht die offensichtlichsten Details wie die Anmeldung am System. Es wäre auch sinnvoll, den Fehler mehrmals selbst zu reproduzieren und dann anzugeben, wie viele Versuche erfolgreich waren, um den Fehler zu aktivieren.

Erwartetes Ergebnis

Erläutern Sie, was passieren sollte, wenn Sie die Reproduktionsschritte ausführen und alles richtig funktioniert. Wenn wir das Beispiel “Die Schaltfläche “Kontakt” funktioniert nicht” noch einmal aufgreifen, kann das erwartete Ergebnis wie folgt aussehen: “Das Kontaktformular wird angezeigt”.

Tatsächliches Ergebnis

Hier sollten Sie den Fehler selbst beschreiben. Was passiert, nachdem Sie alle Reproduktionsschritte durchgeführt haben? Was ist falsch? Hier ist ein Beispiel: “Das Kontaktformular öffnet sich nicht”.

Beweise

Fügen Sie Bilder und Videos bei – das beschleunigt den Prozess der Fehlerreproduktion.

Schweregrad

Wie kritisch ist der Fehler? Welche Auswirkungen hat er auf die Funktionalität des Systems? Diese Informationen helfen den Managern, ihre Aufgaben nach Prioritäten zu ordnen, was besonders wichtig ist, wenn zahlreiche Fehler zu beheben sind. Beispielsweise sollte ein Fehler, der die Nutzung einer Anwendung blockiert, als kritisch eingestuft werden, aber wenn es sich um einen Tippfehler in der Kopie handelt, kann er als trivial eingestuft werden.

Ihr Name

Geben Sie Ihren Namen und Ihre Kontaktdaten an, damit die Entwickler leicht mit Ihnen in Kontakt treten können. Dies kann notwendig sein, wenn Sie keine spezielle Testsoftware für Fehlerberichte verwenden.

 

 

Bevor wir zur nächsten Empfehlung übergehen, werfen Sie einen Blick auf dieses Beispiel eines guten Fehlerberichts in Jira. Er enthält die Fehlernummer (die automatisch generiert wird), Titel, Umgebung, Reproduktionsschritte (zusammen mit einer Vorbedingung), erwartete und tatsächliche Ergebnisse, Video, Priorität und den Namen des Berichterstatters:

Seien Sie spezifisch

Vermeiden Sie es, einen ganzen Aufsatz zu schreiben – Sie sollten sich auf das Wesentliche beschränken und konkret sein. Geben Sie nur alle wichtigen Details an (wir haben sie im vorherigen Absatz beschrieben), erklären Sie deutlich, was genau falsch ist und wie der Fehler reproduziert werden kann, und das war’s.

Zögern Sie nicht

Wenn Sie einen Fehler entdecken, sollten Sie die Erstellung des Berichts nicht aufschieben. Tun Sie es sofort – sonst vergessen Sie vielleicht einige Schritte, die für die Reproduktion des Fehlers wichtig sind, oder Sie vergessen einfach, einen Bericht zu schreiben. Dies ist besonders wichtig bei kritischen Fehlern, die so schnell wie möglich behoben werden müssen.

Überprüfen Sie den Bericht noch einmal

Nachdem Sie den Bericht geschrieben haben, lesen Sie ihn noch einmal. Können einige Sätze falsch interpretiert werden? Gibt es Unklarheiten? Wenn ja, beseitigen Sie diese Probleme, bevor Sie den Bericht abschicken. Wenn Sie dies nicht tun, wird die Behebung des Fehlers mehr Zeit in Anspruch nehmen.

Vermeiden Sie Kritik

Natürlich sind Bugs ärgerlich, aber Kritik an den Entwicklern macht Ihren Bericht nicht besser und effektiver. Seien Sie diskret (auch wenn der Fehler sehr ärgerlich ist oder ein weiteres Mal auftritt, nachdem er behoben werden musste), und beschreiben Sie das Problem einfach klar und deutlich. Denken Sie daran, dass ein guter Bericht in einer einfachen, trockenen Sprache geschrieben ist und keine Beleidigungen enthält.

Tools und Dienste verwenden

Hier finden Sie einige der praktischsten Tools und Dienste, die von :

Abschließende Überlegungen

Um einen guten Fehlerbericht zu verfassen, müssen Sie spezifisch sein und alle Details angeben, wie Fehlernummer, Titel, Umgebung, Reproduktionsschritte, erwartetes und tatsächliches Ergebnis, Screenshots und/oder Videos, Schweregrad und Ihren Namen sowie Ihre Kontaktdaten. Schreiben Sie Ihre Berichte in klarer Sprache, kritisieren Sie die Entwickler nicht und überprüfen Sie die Berichte doppelt, bevor Sie sie abschicken. Und natürlich sollten Sie nicht zögern, Ihre Berichte zu schreiben und abzuschicken – tun Sie dies sofort, nachdem Sie einen Fehler entdeckt haben.

Was die Tools und Dienste angeht, so ist Jira eine der beliebtesten und bequemsten Optionen, die Ihr Team vielleicht schon nutzt. Wenn ja, sollten Sie seine Funktionen nicht vernachlässigen. Auf jeden Fall sollte das gesamte Team eine Plattform für das Projektmanagement nutzen, da dies eine gute Zusammenarbeit und eine effektive Aufgabenerledigung gewährleistet. Einige Tools (wie Bird Eats Bug) können jedoch dank ihrer Integrationsfunktionen auch unabhängig voneinander verwendet werden.