Wie schreibe ich einen guten Fehlerbericht? Tipps und Tricks

Sep 30, 2021
admin

Warum ein guter Fehlerbericht?

Wenn Ihr Fehlerbericht effektiv ist, dann sind die Chancen höher, dass er behoben wird. Die Behebung eines Fehlers hängt also davon ab, wie effektiv Sie ihn melden. Einen Fehler zu melden ist nichts anderes als eine Fähigkeit, und ich werde erklären, wie man diese Fähigkeit erlangt.

„Der Sinn des Schreibens von Problemberichten (Fehlerberichten) ist es, Fehler zu beheben“ – von Cem Kaner. Wenn ein Tester einen Fehler nicht korrekt meldet, wird der Programmierer diesen Fehler höchstwahrscheinlich ablehnen und ihn als nicht reproduzierbar bezeichnen.

Wie man einen guten Fehlerbericht schreibt

Das kann die Moral des Testers verletzen und manchmal auch sein Ego. (Ich schlage vor, keine Art von Ego zu haben. Ego’s wie „Ich habe den Fehler richtig gemeldet“, „Ich kann ihn reproduzieren“, „Warum hat er/sie den Fehler abgelehnt?“, „Es ist nicht meine Schuld“ usw.).

Was sind die Qualitäten eines guten Software-Fehlerberichts?

Jeder kann einen Fehlerbericht schreiben. Aber nicht jeder kann einen effektiven Fehlerbericht schreiben.

Sie sollten in der Lage sein, zwischen einem durchschnittlichen Fehlerbericht und einem guten Fehlerbericht zu unterscheiden. Wie kann man zwischen einem guten und einem schlechten Fehlerbericht unterscheiden? Es ist sehr einfach, wenden Sie die folgenden Merkmale und Techniken an, um einen Fehler zu melden.

Zu den Merkmalen und Techniken gehören

#1) Eine klar definierte Fehlernummer: Vergeben Sie immer eine eindeutige Nummer für jeden Fehlerbericht. Dies wiederum hilft Ihnen, den Fehlerbericht zu identifizieren. Wenn Sie ein automatisiertes Bug-Reporting-Tool verwenden, wird diese eindeutige Nummer jedes Mal automatisch generiert, wenn Sie den Fehler melden.

Notieren Sie die Nummer und eine kurze Beschreibung jedes Fehlers, den Sie gemeldet haben.

#2) Reproduzierbar: Wenn Ihr Fehler nicht reproduzierbar ist, wird er nie behoben werden.

Sie sollten die Schritte zur Reproduktion des Fehlers klar angeben. Nehmen Sie keine Schritte zur Reproduktion an oder lassen Sie sie aus. Ein Fehler, der Schritt für Schritt beschrieben wird, ist leicht zu reproduzieren und zu beheben.

#3) Sei spezifisch: Schreiben Sie keinen Aufsatz über das Problem.

Sein Sie konkret und auf den Punkt. Versuchen Sie, das Problem in wenigen Worten, aber wirkungsvoll zusammenzufassen. Fassen Sie nicht mehrere Probleme zusammen, auch wenn sie ähnlich zu sein scheinen. Schreiben Sie für jedes Problem einen eigenen Bericht.

Effektive Fehlerberichte

Fehlerberichte sind ein wichtiger Aspekt des Softwaretests. Ein effektiver Fehlerbericht kommuniziert gut mit dem Entwicklungsteam und vermeidet Verwirrung oder Missverständnisse.

Ein guter Fehlerbericht sollte klar und prägnant sein und keine wichtigen Punkte auslassen. Jeder Mangel an Klarheit führt zu Missverständnissen und verlangsamt den Entwicklungsprozess ebenfalls. Das Schreiben und Melden von Fehlern ist einer der wichtigsten, aber vernachlässigten Bereiche im Testlebenszyklus.

Gutes Schreiben ist sehr wichtig für das Einreichen eines Fehlers. Der wichtigste Punkt, den ein Tester im Auge behalten sollte, ist, keinen befehlenden Ton im Bericht zu verwenden. Das macht die Moral kaputt und schafft ein ungesundes Arbeitsverhältnis. Verwenden Sie einen suggestiven Ton.

Gehen Sie nicht davon aus, dass der Entwickler einen Fehler gemacht hat und Sie deshalb harte Worte verwenden können. Bevor Sie einen Fehler melden, ist es ebenso wichtig zu prüfen, ob derselbe Fehler bereits gemeldet wurde oder nicht.

Ein doppelter Fehler ist eine Belastung im Testzyklus. Überprüfen Sie die gesamte Liste der bekannten Fehler. Es kann vorkommen, dass die Entwickler das Problem kannten und es für eine zukünftige Version ignoriert haben. Tools wie Bugzilla, die automatisch nach doppelten Fehlern suchen, können ebenfalls verwendet werden. Es ist jedoch am besten, manuell nach jedem doppelten Fehler zu suchen.

Die wichtigsten Informationen, die ein Fehlerbericht vermitteln muss, sind „Wie?“ und „Wo?“. Der Bericht sollte klar beantworten, wie der Test durchgeführt wurde und wo genau der Fehler aufgetreten ist. Der Leser sollte den Fehler leicht reproduzieren und herausfinden können, wo der Fehler liegt.

Denken Sie daran, dass das Ziel des Fehlerberichts darin besteht, dem Entwickler die Möglichkeit zu geben, das Problem zu visualisieren. Er/sie sollte den Fehler aus dem Fehlerbericht klar verstehen. Denken Sie daran, alle relevanten Informationen zu geben, die der Entwickler sucht.

Auch sollten Sie daran denken, dass ein Fehlerbericht für die spätere Verwendung aufbewahrt wird und gut mit den erforderlichen Informationen geschrieben sein sollte. Verwenden Sie aussagekräftige Sätze und einfache Worte, um Ihre Fehler zu beschreiben. Verwenden Sie keine verwirrenden Aussagen, die die Zeit des Überprüfers verschwenden.

Berichten Sie jeden Fehler als separates Problem. Bei mehreren Problemen in einem einzigen Fehlerbericht können Sie diesen nicht schließen, bevor nicht alle Probleme gelöst sind.

Es ist daher am besten, die Probleme in separate Bugs aufzuteilen. Dadurch wird sichergestellt, dass jeder Fehler separat behandelt werden kann. Ein gut geschriebener Fehlerbericht hilft einem Entwickler, den Fehler an seinem Terminal zu reproduzieren. Das hilft ihnen auch bei der Diagnose des Problems.

Wie meldet man einen Bug?

Verwenden Sie die folgende einfache Bug-Report-Vorlage:

Dies ist ein einfaches Bug-Report-Format. Es kann je nach dem von Ihnen verwendeten Fehlerberichtstool variieren. Wenn Sie einen Fehlerbericht manuell schreiben, dann müssen einige Felder speziell erwähnt werden, wie die Fehlernummer, die manuell zugewiesen werden sollte.

Reporter: Ihr Name und Ihre E-Mail-Adresse.

Produkt: In welchem Produkt Sie diesen Fehler gefunden haben.

Version: Die Produktversion, falls vorhanden.

Komponente: Dies sind die wichtigsten Untermodule des Produkts.

Plattform: Geben Sie die Hardware-Plattform an, auf der Sie den Fehler gefunden haben. Die verschiedenen Plattformen wie ‚PC‘, ‚MAC‘, ‚HP‘, ‚Sun‘ usw.

Betriebssystem: Geben Sie alle Betriebssysteme an, auf denen Sie den Fehler gefunden haben. Betriebssysteme wie Windows, Linux, Unix, SunOS, Mac OS. Erwähnen Sie auch die verschiedenen Betriebssystemversionen wie Windows NT, Windows 2000, Windows XP usw., falls zutreffend.

Priorität: Wann sollte ein Fehler behoben werden? Die Priorität wird im Allgemeinen von P1 bis P5 festgelegt. P1 steht für „den Fehler mit der höchsten Priorität beheben“ und P5 für „beheben, wenn es die Zeit erlaubt“.

Schweregrad: Dies beschreibt die Auswirkung des Fehlers.
Arten der Schwere:

  • Blocker: Es können keine weiteren Testarbeiten durchgeführt werden.
  • Kritisch: Absturz der Anwendung, Verlust von Daten.
  • Schwerwiegend: Schwerer Funktionsverlust.
  • Geringfügig: Geringfügiger Funktionsverlust.
  • Trivial: Einige UI-Verbesserungen.
  • Verbesserung: Anfrage für eine neue Funktion oder eine Verbesserung der bestehenden Funktion.

Status: Wenn Sie den Fehler in ein Fehlerverfolgungssystem eintragen, ist der Fehlerstatus standardmäßig „Neu“.
Später durchläuft der Fehler verschiedene Stadien wie „Behoben“, „Verifiziert“, „Wiedereröffnen“, „Wird nicht behoben“ usw.

=> Klicken Sie hier, um mehr über den detaillierten Fehlerlebenszyklus zu erfahren.

Zuweisen an: Wenn Sie wissen, welcher Entwickler für das bestimmte Modul, in dem der Fehler aufgetreten ist, verantwortlich ist, können Sie die E-Mail-Adresse dieses Entwicklers angeben. Andernfalls lassen Sie das Feld leer, da der Fehler dann dem Modulverantwortlichen zugewiesen wird, andernfalls weist der Manager den Fehler dem Entwickler zu. Fügen Sie eventuell die E-Mail-Adresse des Managers in die CC-Liste ein.

URL: Die URL der Seite, auf der der Fehler aufgetreten ist.

Zusammenfassung: Eine kurze Zusammenfassung des Fehlers, meist in 60 Wörtern oder weniger. Achten Sie darauf, dass Ihre Zusammenfassung das Problem und den Ort des Auftretens wiedergibt.

Beschreibung: Eine detaillierte Beschreibung des Fehlers.

Nutzen Sie die folgenden Felder für das Beschreibungsfeld:

  • Reproduktionsschritte: Geben Sie klar und deutlich die Schritte an, mit denen der Fehler reproduziert werden kann.
  • Erwartetes Ergebnis: Wie sollte sich die Anwendung bei den oben erwähnten Schritten verhalten.
  • Tatsächliches Ergebnis: Was ist das tatsächliche Ergebnis der Ausführung der oben genannten Schritte, d.h. das Verhalten des Fehlers.

Dies sind die wichtigen Schritte im Fehlerbericht. Sie können auch den „Berichtstyp“ als ein weiteres Feld hinzufügen, das den Fehlertyp beschreibt.

Berichtstypen sind:

1) Codierungsfehler
2) Designfehler
3) Neuer Vorschlag
4) Dokumentationsproblem
5) Hardwareproblem

Wichtige Merkmale in Ihrem Fehlerbericht

Nachfolgend sind die wichtigen Merkmale im Fehlerbericht aufgeführt:

#1) Fehlernummer/id

Eine Fehlernummer oder eine Identifikationsnummer (z.B. swb001) macht das Berichten von Fehlern und das Nachschlagen eines Fehlers viel einfacher. Der Entwickler kann leicht überprüfen, ob ein bestimmter Fehler behoben wurde oder nicht. Es macht den gesamten Test- und Wiederholungsprozess reibungsloser und einfacher.

#2) Fehlertitel

Ein Fehlertitel wird öfter gelesen als jeder andere Teil des Fehlerberichts. Er sollte alles darüber aussagen, was in dem Fehler steht.

Der Fehlertitel sollte so aussagekräftig sein, dass der Leser ihn verstehen kann. Ein klarer Fehlertitel macht es leicht zu verstehen und der Leser kann wissen, ob der Fehler schon früher gemeldet oder behoben wurde.

#3) Priorität

Basierend auf der Schwere des Fehlers, kann eine Priorität für ihn festgelegt werden. Ein Fehler kann ein Blocker, Critical, Major, Minor, Trivial, oder ein Suggestion sein. Es kann eine Fehlerpriorität von P1 bis P5 vergeben werden, so dass die wichtigen Fehler zuerst angezeigt werden.

#4) Plattform/Umgebung

Die Betriebssystem- und Browserkonfiguration ist für einen klaren Fehlerbericht notwendig. Es ist der beste Weg, um mitzuteilen, wie der Fehler reproduziert werden kann.

Ohne die genaue Plattform oder Umgebung kann sich die Anwendung anders verhalten und der Fehler auf der Seite des Testers kann nicht auf der Seite des Entwicklers repliziert werden. Daher ist es am besten, die Umgebung, in der der Fehler entdeckt wurde, deutlich zu erwähnen.

#5) Beschreibung

Die Fehlerbeschreibung hilft dem Entwickler, den Fehler zu verstehen. Sie beschreibt das aufgetretene Problem. Eine schlechte Beschreibung führt zu Verwirrung und verschwendet die Zeit der Entwickler und der Tester.

Es ist notwendig, die Wirkung der Beschreibung klar zu kommunizieren. Es ist immer hilfreich, vollständige Sätze zu verwenden. Es ist eine gute Praxis, jedes Problem einzeln zu beschreiben, anstatt es in einem Satz zu zerbröseln. Verwenden Sie keine Ausdrücke wie „ich denke“ oder „ich glaube“.

#6) Schritte zur Reproduktion

Ein guter Fehlerbericht sollte klar die Schritte zur Reproduktion aufführen. Die Schritte sollten Aktionen beinhalten, die den Fehler verursachen. Machen Sie keine generischen Aussagen. Seien Sie bei den zu befolgenden Schritten spezifisch.

Ein gutes Beispiel für ein gut geschriebenes Verfahren ist unten angegeben

Schritte:

  • Wählen Sie das Produkt Abc01.
  • Klicken Sie auf In den Warenkorb.
  • Klicken Sie auf Entfernen, um das Produkt aus dem Warenkorb zu entfernen.

#7) Erwartetes und tatsächliches Ergebnis

Eine Fehlerbeschreibung ist unvollständig ohne die erwarteten und tatsächlichen Ergebnisse. Es ist notwendig, das Ergebnis des Tests zu umreißen und zu beschreiben, was der Benutzer erwarten sollte. Der Leser sollte wissen, was das richtige Ergebnis des Tests ist. Erwähnen Sie klar und deutlich, was während des Tests passiert ist und was das Ergebnis war.

#8) Screenshot

Ein Bild sagt mehr als tausend Worte. Machen Sie einen Screenshot des Fehlers mit entsprechender Beschriftung, um den Fehler hervorzuheben. Heben Sie unerwartete Fehlermeldungen mit hellroter Farbe hervor. Dies lenkt die Aufmerksamkeit auf den erforderlichen Bereich.

Einige zusätzliche Tipps, um einen guten Fehlerbericht zu schreiben

Nachfolgend finden Sie einige weitere Tipps, um einen guten Fehlerbericht zu schreiben:

#1) Melden Sie das Problem sofort

Wenn Sie beim Testen einen Fehler finden, dann brauchen Sie nicht zu warten, um später einen detaillierten Fehlerbericht zu schreiben. Schreiben Sie stattdessen sofort einen Fehlerbericht. Dadurch wird ein guter und reproduzierbarer Fehlerbericht gewährleistet. Wenn Sie sich entscheiden, den Fehlerbericht später zu schreiben, dann ist die Wahrscheinlichkeit groß, dass Sie wichtige Schritte in Ihrem Bericht übersehen.

#2) Reproduzieren Sie den Fehler dreimal, bevor Sie einen Fehlerbericht schreiben

Ihr Fehler sollte reproduzierbar sein. Vergewissern Sie sich, dass Ihre Schritte robust genug sind, um den Fehler zweifelsfrei zu reproduzieren. Wenn Ihr Fehler nicht jedes Mal reproduzierbar ist, können Sie immer noch einen Fehlerbericht schreiben, in dem Sie die periodische Natur des Fehlers erwähnen.

#3) Testen Sie das gleiche Auftreten des Fehlers in anderen ähnlichen Modulen

Manchmal verwendet der Entwickler den gleichen Code für verschiedene ähnliche Module. Es besteht also eine höhere Wahrscheinlichkeit, dass der Fehler in einem Modul auch in anderen ähnlichen Modulen auftritt. Sie können sogar versuchen, die schwerwiegendere Version des gefundenen Fehlers zu finden.

#4) Schreiben Sie eine gute Fehlerzusammenfassung

Die Fehlerzusammenfassung hilft den Entwicklern, die Art des Fehlers schnell zu analysieren. Ein Bericht von schlechter Qualität erhöht unnötig die Entwicklungs- und Testzeit. Kommunizieren Sie gut mit Ihrer Fehlerbericht-Zusammenfassung. Denken Sie daran, dass die Fehlerzusammenfassung als Referenz verwendet wird, um den Fehler im Fehlerinventar zu suchen.

#5) Lesen Sie den Fehlerbericht, bevor Sie auf die Schaltfläche „Absenden“ drücken

Lesen Sie alle Sätze, Formulierungen und Schritte, die im Fehlerbericht verwendet werden. Achten Sie darauf, ob irgendein Satz eine Zweideutigkeit erzeugt, die zu Fehlinterpretationen führen kann. Irreführende Wörter oder Sätze sollten vermieden werden, um einen klaren Fehlerbericht zu erstellen.

#6) Verwenden Sie keine missbräuchliche Sprache

Es ist schön, dass Sie gute Arbeit geleistet und einen Fehler gefunden haben, aber verwenden Sie diese Anerkennung nicht, um den Entwickler zu kritisieren oder um eine Person anzugreifen.

Schlussfolgerung

Es besteht kein Zweifel, dass Ihr Fehlerbericht ein qualitativ hochwertiges Dokument sein sollte.

Konzentrieren Sie sich auf das Schreiben guter Fehlerberichte und verwenden Sie etwas Zeit auf diese Aufgabe, da dies der wichtigste Kommunikationspunkt zwischen Tester, Entwickler und Manager ist. Manager sollten in ihrem Team ein Bewusstsein dafür schaffen, dass das Schreiben eines guten Fehlerberichts die Hauptverantwortung eines jeden Testers ist.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.