Menü

Wie schreibe ich einen guten Fehlerbericht? Tipps und Tricks

how write good bug report

Versuchen Sie Unser Instrument, Um Probleme Zu Beseitigen

Warum guter Bug Report?

Wenn Ihr Fehlerbericht effektiv ist, sind die Chancen, behoben zu werden, höher. Die Behebung eines Fehlers hängt also davon ab, wie effektiv Sie ihn melden. Das Melden eines Fehlers ist nichts anderes als eine Fähigkeit, und ich werde erklären, wie diese Fähigkeit erreicht werden kann.

'Der Sinn des Schreibens eines Problemberichts (Fehlerbericht) besteht darin, Fehler zu beheben' - Von Cem Kaner. Wenn ein Tester einen Fehler nicht korrekt meldet, wird der Programmierer diesen Fehler höchstwahrscheinlich als nicht reproduzierbar ablehnen.

So schreiben Sie einen guten Fehlerbericht

Dies kann die Moral der Tester und manchmal auch das Ego verletzen. (Ich schlage vor, keine Art von Ego zu behalten. Das Ego lautet wie 'Ich habe den Fehler korrekt gemeldet', 'Ich kann ihn reproduzieren', 'Warum hat er / sie den Fehler abgelehnt?', 'Es ist nicht meine Schuld' usw. ,).

Was du lernen wirst:

Was sind die Eigenschaften 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, die folgenden Eigenschaften und Techniken anzuwenden, um einen Fehler zu melden.

Eigenschaften und Techniken umfassen

# 1) Mit einer klar spezifizierten Fehlernummer: Weisen Sie jedem Fehlerbericht immer eine eindeutige Nummer zu. Dies hilft Ihnen wiederum dabei, den Fehlerdatensatz zu identifizieren. Wenn Sie ein automatisiertes Tool zur Fehlerberichterstattung verwenden, wird diese eindeutige Nummer jedes Mal automatisch generiert, wenn Sie den Fehler melden.

Notieren Sie sich die Nummer und eine kurze Beschreibung jedes von Ihnen gemeldeten Fehlers.

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

Sie sollten die Schritte zur Reproduktion des Fehlers klar erwähnen. Nehmen Sie keinen Wiedergabeschritt an oder überspringen Sie ihn. Ein Fehler, der Schritt für Schritt beschrieben wird, ist leicht zu reproduzieren und zu beheben.

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

Seien Sie spezifisch und auf den Punkt. Versuchen Sie, das Problem in minimalen Worten und dennoch auf effektive Weise zusammenzufassen. Kombinieren Sie nicht mehrere Probleme, auch wenn sie ähnlich zu sein scheinen. Schreiben Sie für jedes Problem unterschiedliche Berichte.

Effektive Fehlerberichterstattung

Die Fehlerberichterstattung ist ein wichtiger Aspekt beim Testen von Software. Ein effektiver Fehlerbericht kommuniziert gut mit dem Entwicklungsteam und vermeidet Verwirrung oder Missverständnisse.

Ein guter Fehlerbericht sollte sein klar und prägnant ohne fehlende Schlüsselpunkte. Unklarheiten führen zu Missverständnissen und verlangsamen auch den Entwicklungsprozess. Das Schreiben und Melden von Fehlern ist einer der wichtigsten, aber vernachlässigten Bereiche im Testlebenszyklus.

Gutes Schreiben ist sehr wichtig, um einen Fehler zu melden. Der wichtigste Punkt, den ein Tester beachten sollte, ist keinen befehlenden Ton zu verwenden im Bericht. Dies bricht die Moral und schafft eine ungesunde Arbeitsbeziehung. Verwenden Sie einen suggestiven Ton.

Gehen Sie nicht davon aus dass der Entwickler einen Fehler gemacht hat und Sie daher harte Worte verwenden können. Vor dem Melden ist es ebenso wichtig zu überprüfen, ob derselbe Fehler gemeldet wurde oder nicht.

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

Die Importinformationen, die ein Fehlerbericht kommunizieren muss, sind 'Wie?' und wo?' Der Bericht sollte klar beantworten, wie der Test durchgeführt wurde und wo der Fehler genau aufgetreten ist. Der Leser sollte den Fehler leicht reproduzieren und herausfinden können, wo sich der Fehler befindet.

Array in umgekehrter Reihenfolge drucken Java

Denken Sie daran, dass die Ziel des Schreibens des Bug-Berichts soll dem Entwickler ermöglichen, das Problem zu visualisieren. Er / Sie sollte den Fehler aus dem Fehlerbericht klar verstehen. Denken Sie daran, alle relevanten Informationen anzugeben, nach denen der Entwickler sucht.

Denken Sie auch daran, dass ein Fehlerbericht für die zukünftige Verwendung aufbewahrt wird und mit den erforderlichen Informationen gut geschrieben sein sollte. Verwenden Sie aussagekräftige Sätze und einfache Wörter um deine Fehler zu beschreiben. Verwenden Sie keine verwirrenden Aussagen, die die Zeit des Überprüfers verschwenden.

Melden Sie jeden Fehler als separates Problem. Bei mehreren Problemen in einem einzelnen Fehlerbericht können Sie ihn erst schließen, wenn alle Probleme behoben sind.

Daher ist es am besten zu Teilen Sie die Probleme in separate Fehler auf . Dies stellt sicher, dass jeder Fehler separat behandelt werden kann. Ein gut geschriebener Fehlerbericht hilft einem Entwickler, den Fehler an seinem Terminal zu reproduzieren. Dies hilft ihnen auch bei der Diagnose des Problems.

Wie melde ich einen Fehler?

Verwenden Sie die folgende einfache Vorlage für Fehlerberichte:

Dies ist ein einfaches Format für Fehlerberichte. Dies kann je nach verwendetem Fehlerbericht-Tool variieren. Wenn Sie einen Fehlerbericht manuell schreiben, müssen einige Felder speziell erwähnt werden, z. B. die Fehlernummer, die manuell zugewiesen werden sollte.

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

Produkt: In welchem ​​Produkt haben Sie diesen Fehler gefunden?

Ausführung: Die Produktversion, falls vorhanden.

Komponente: Dies sind die wichtigsten Untermodule des Produkts.

Plattform: Erwähnen Sie die Hardwareplattform, auf der Sie diesen Fehler gefunden haben. Die verschiedenen Plattformen wie 'PC', 'MAC', 'HP', 'Sun' usw.

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

Priorität: Wann sollte ein Fehler behoben werden? Die Priorität wird im Allgemeinen von P1 bis P5 eingestellt. P1 als 'Fehler mit der höchsten Priorität beheben' und P5 als 'Beheben, wenn es die Zeit erlaubt'.

Schwere: Dies beschreibt die Auswirkungen des Fehlers.
Arten des Schweregrads:

  • Blocker: Es können keine weiteren Testarbeiten durchgeführt werden.
  • Kritisch: Anwendungsabsturz, Datenverlust.
  • Haupt: Großer Funktionsverlust.
  • Geringer: Geringer Funktionsverlust.
  • Trivial: Einige Verbesserungen der Benutzeroberfläche.
  • Erweiterung: Fordern Sie eine neue Funktion oder eine Erweiterung der vorhandenen an.

Status: Wenn Sie den Fehler in einem Fehlerverfolgungssystem anmelden, lautet der Fehlerstatus standardmäßig 'Neu'.
Später durchläuft der Fehler verschiedene Phasen wie 'Behoben', 'Verifiziert', 'Wieder öffnen', 'Wird nicht behoben' usw.

=> Klicke hier Lesen Sie mehr über den detaillierten Bug-Lebenszyklus.

Zuweisen: Wenn Sie wissen, welcher Entwickler für das Modul verantwortlich ist, in dem der Fehler aufgetreten ist, können Sie die E-Mail-Adresse dieses Entwicklers angeben. Andernfalls lassen Sie es leer, da dies den Fehler dem Modulbesitzer zuweist, wenn der Manager den Fehler nicht dem Entwickler zuweist. Fügen Sie möglicherweise die E-Mail-Adresse des Managers in die CC-Liste ein.

URL: Die Seiten-URL, auf der der Fehler aufgetreten ist.

Zusammenfassung: Eine kurze Zusammenfassung des Fehlers meist in 60 Wörtern oder weniger. Stellen Sie sicher, dass Ihre Zusammenfassung darüber nachdenkt, wo das Problem liegt und wo es sich befindet.

Beschreibung: Eine detaillierte Beschreibung des Fehlers.

Verwenden Sie die folgenden Felder für das Beschreibungsfeld:

  • Schritte reproduzieren: Erwähnen Sie deutlich die Schritte zum Reproduzieren des Fehlers.
  • Erwartetes Ergebnis: Wie sich die Anwendung bei den oben genannten Schritten verhalten soll.
  • Tatsächliche Ergebnis: Was ist das tatsächliche Ergebnis der Ausführung der obigen Schritte, d. H. Das Fehlerverhalten.

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

Zu den Berichtstypen gehören:

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

Wichtige Funktionen in Ihrem Fehlerbericht

Im Folgenden sind die wichtigen Funktionen im Fehlerbericht aufgeführt:

# 1) Fehlernummer / ID

Eine Fehlernummer oder eine Identifikationsnummer (wie swb001) erleichtert das Melden von Fehlern und das Verweisen auf einen Fehler erheblich. Der Entwickler kann leicht überprüfen, ob ein bestimmter Fehler behoben wurde oder nicht. Dies macht den gesamten Test- und Wiederholungsprozess reibungsloser und einfacher.

# 2) Fehlertitel

Ein Fehlertitel wird häufiger gelesen als jeder andere Teil des Fehlerberichts. Es sollte alles darüber sagen, was in dem Fehler kommt.

Der Bug-Titel sollte so aussagekräftig sein, dass der Leser ihn verstehen kann. Ein klarer Fehlertitel erleichtert das Verständnis und der Leser kann feststellen, ob der Fehler früher gemeldet oder behoben wurde.

# 3) Priorität

Basierend auf der Schwere des Fehlers kann eine Priorität festgelegt werden. Ein Fehler kann ein Blocker, ein kritischer, ein Major, ein Minor, ein Trivial oder ein Vorschlag sein. Eine Fehlerpriorität von P1 bis P5 kann angegeben werden, damit die wichtigen zuerst angezeigt werden.

# 4) Plattform / Umgebung

Die Betriebssystem- und Browserkonfiguration ist für einen eindeutigen Fehlerbericht erforderlich. Dies ist der beste Weg, um zu kommunizieren, wie der Fehler reproduziert werden kann.

Ohne die genaue Plattform oder Umgebung verhält sich die Anwendung möglicherweise anders und der Fehler am Ende des Testers wird möglicherweise nicht am Ende des Entwicklers repliziert. Erwähnen Sie daher am besten deutlich die Umgebung, in der der Fehler erkannt wurde.

# 5) Beschreibung

Die Fehlerbeschreibung hilft dem Entwickler, den Fehler zu verstehen. Es beschreibt das aufgetretene Problem. Die schlechte Beschreibung wird Verwirrung stiften und die Zeit der Entwickler und der Tester verschwenden.

Es ist notwendig, klar über die Wirkung der Beschreibung zu kommunizieren. Es ist immer hilfreich, vollständige Sätze zu verwenden. Es ist eine gute Praxis, jedes Problem einzeln zu beschreiben, anstatt es insgesamt zu zerbröckeln. Verwenden Sie keine Begriffe wie 'Ich denke' oder 'Ich glaube'.

# 6) Schritte zum Reproduzieren

In einem guten Fehlerbericht sollten die zu reproduzierenden Schritte klar angegeben werden. Die Schritte sollten Aktionen enthalten, die den Fehler verursachen. Machen Sie keine generischen Aussagen. Seien Sie genau in den folgenden Schritten.

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

Schritte:

  • Wählen Sie das Produkt Abc01 aus.
  • 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 ohne die erwarteten und tatsächlichen Ergebnisse unvollständig. Es muss dargelegt werden, was das Ergebnis des Tests ist und was der Benutzer erwarten sollte. Der Leser sollte wissen, was das richtige Ergebnis des Tests ist. Erwähnen Sie 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 Fehlerfalls mit der richtigen Beschriftung, um den Fehler hervorzuheben. Markieren Sie unerwartete Fehlermeldungen mit hellroter Farbe. Dies macht auf den gewünschten Bereich aufmerksam.

Einige Bonus-Tipps zum Schreiben eines guten Fehlerberichts

Im Folgenden finden Sie einige weitere zusätzliche Tipps zum Schreiben eines guten Fehlerberichts:

# 1) Melden Sie das Problem sofort

Was ist ein guter Stimmwechsler?

Wenn Sie beim Testen einen Fehler finden, müssen Sie nicht warten, um später einen detaillierten Fehlerbericht zu schreiben. Schreiben Sie stattdessen sofort den Fehlerbericht. Dies stellt einen guten und reproduzierbaren Fehlerbericht sicher. Wenn Sie sich entscheiden, den Fehlerbericht später zu schreiben, besteht eine hohe Wahrscheinlichkeit, dass Sie die wichtigen Schritte in Ihrem Bericht verpassen.

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

Ihr Fehler sollte reproduzierbar sein. Stellen Sie sicher, dass Ihre Schritte robust genug sind, um den Fehler ohne Mehrdeutigkeit zu reproduzieren. Wenn Ihr Fehler nicht jedes Mal reproduzierbar ist, können Sie dennoch einen Fehler einreichen, in dem die periodische Natur des Fehlers erwähnt wird.

# 3) Testen Sie das gleiche Auftreten von Fehlern auf anderen ähnlichen Modulen

Manchmal verwendet der Entwickler denselben 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 Zusammenfassung der Fehler

Die Fehlerzusammenfassung hilft den Entwicklern, die Fehlerart schnell zu analysieren. Ein Bericht mit schlechter Qualität verlängert die Entwicklungs- und Testzeit unnötig. Kommunizieren Sie gut mit Ihrer Zusammenfassung der Fehlerberichte. Beachten Sie, dass die Fehlerübersicht als Referenz für die Suche nach dem Fehler im Fehlerinventar verwendet wird.

# 5) Lesen Sie den Fehlerbericht, bevor Sie auf die Schaltfläche Senden klicken

Lesen Sie alle Sätze, Formulierungen und Schritte, die im Fehlerbericht verwendet werden. Überprüfen Sie, ob ein Satz Mehrdeutigkeiten erzeugt, die zu Fehlinterpretationen führen können. Irreführende Wörter oder Sätze sollten vermieden werden, um einen eindeutigen Fehlerbericht zu erhalten.

# 6) Verwenden Sie keine missbräuchliche Sprache

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

Fazit

Kein Zweifel, dass Ihr Fehlerbericht ein qualitativ hochwertiges Dokument sein sollte.

Konzentrieren Sie sich darauf, gute Fehlerberichte zu schreiben, und verbringen Sie einige Zeit mit dieser Aufgabe, da dies der Hauptkommunikationspunkt zwischen dem Tester, dem Entwickler und dem Manager ist. Manager sollten ein Bewusstsein für ihr Team schaffen, dass das Schreiben eines guten Fehlerberichts die Hauptverantwortung eines jeden Testers ist.

Ihre Bemühungen, einen guten Fehlerbericht zu schreiben, sparen nicht nur die Ressourcen des Unternehmens, sondern schaffen auch eine gute Beziehung zwischen Ihnen und den Entwicklern.

Schreiben Sie für eine bessere Produktivität einen besseren Fehlerbericht.

Sind Sie ein Experte beim Schreiben eines Fehlerberichts? Fühlen Sie sich frei, Ihre Gedanken in den Kommentaren unten zu teilen.

Literatur-Empfehlungen

^