Andrii Yalanskyi | shutterstock.com

Bugs zu beheben, ist für alle Softwareentwickler Alltag – egal, ob es um eine Greenfield-Anwendung geht oder ein Legacy-System. Wie schwierig es sich gestaltet, Bugs zu fixen, hängt dabei von diversen Faktoren ab. Die in den meisten Fällen außerhalb der Kontrolle der Entwickler liegen.

Geht’s allerdings um die Qualität des Bug Reports, sieht die Sache anders aus. Das sollte jeder Entwickler oder QA-Tester, der etwas auf sich hält, beherrschen. Denn einen guten Fehlerbericht erstellen zu können, erleichtert es erheblich, Fehler zu reproduzieren. Und man kann nur beheben, was man auch reproduzieren kann. Die folgenden fünf Aspekte gehören deshalb meiner Meinung nach in jeden guten Bug Report.

1. Klarer und prägnanter Titel

Dass der Titel des Bug Reports aussagekräftig ist, ist essenziell. Die meisten Issue-Tracker heben diesen Titel in allen Listen, die sie als Antwort auf Anfragen bereitstellen, deutlich hervor. Kann man daran ablesen, um welchen Bug es (genau) geht, ist das von unschätzbarem Wert, denn es spart Zeit und verhindert Unklarheiten. Nehmen Sie sich also einen Moment und stellen Sie sicher, dass Ihr Issue ordentlich betitelt ist.

2. Reproduktionsanleitung

Der Fokus eines Bug Reports sollte darauf gerichtet sein, Fehler reproduzieren zu können. Nur so lassen diese sich anschließend auch beheben. Von entscheidender Bedeutung ist deshalb vor allem, wie der Bug entsteht. Deshalb sollte der Report die dazu nötigen Schritte auch detailliert beschreiben. “Detailliert” heißt in diesem Fall, jede einzelne Aktion auf dem Weg zum Bug zu erfassen – bis hin zu Mausklicks und Tastenanschlägen. Je detaillierter die einzelnen Schritte dabei beschrieben sind, desto besser.

3. Verhaltensanalyse

Bugs treten auf, weil etwas passieren sollte, aber stattdessen etwas anderes passiert. Manchmal wird Output falsch ausgegeben, in anderen Fällen kommt es zum Absturz. Ein guter Fehlerbericht definiert, was normalerweise ablaufen sollte und beschreibt dann detailliert, was tatsächlich abläuft. Ist ersteres nicht der Fall, wird es schwierig, abzustellen, was schiefläuft. Schließlich weiß dann niemand, wie sich die Dinge richtig verhalten.

4. Kontext und Details

Kein Bug existiert in einem Vakuum. Deshalb sollten die zugehörigen Reports auch relevante Kontext- oder Systeminformationen umfassen, die möglicherweise hilfreich sind. Dazu kann beispielsweise zählen:

• wie sich der Fehler auf Kundenseite auswirkt,
• bei welchen Betriebssystemen er auftritt, oder
• welche Browser-Typen dabei involviert sind.

Ein wirklich guter Bug Report sollte zudem das Problem auch visualisieren – insbesondere, wenn dieses die Benutzeroberfläche betrifft.

5. Nützliche Zusatzinfos

Eine nützliche Zusatzinformation wäre beispielsweise ein kurzes Video, in dem der Bug reproduziert wird. Das “live” mitzuverfolgen, kann zu besserem Durchblick beitragen. Eine weitere nützliche Hilfestellung könnte auch eine Datenbank darstellen, die es erleichtert, das Problem zu reproduzieren. Viele Anwendungen halten Einstellungen in einer Datenbank vor, deren Einzelheiten nützlich für Reproduktionszwecke sein können. (fm)

Sie wollen weitere interessante Beiträge zu diversen Themen aus der IT-Welt lesen? Unsere kostenlosen Newsletter liefern Ihnen alles, was IT-Profis wissen sollten – direkt in Ihre Inbox!