Das Schreiben effektiver Bug-Meldungen

[sakura]

2. Wähle eine gute Überschrift

Die kurze Beschreibung des Bugs wird oft als Überschrift genutzt. Diese ist der wichtigste Teil der Bug-Meldung. Die Fehlerentscheider gehen oft nur nach dem Titel der Bug-Meldung wenn diese über das Schicksal eines Bugs entscheiden. Dabei kann entschieden werden, dass der Bug "sofort" beseitigt wird, dass dieser in einem folgenden Release beseitigt wird, oder gar, wenn der Titel "zu schwach" ist, dass der Bug nicht weiter diskutiert (geschlossen) wird. (Bedenke, in den nächsten zwei Stunden muss über das Schicksal von weiteren 145 Bugs entschieden werden!)

Folgend einige Beispiele:

Gut: Absturz beim Beenden nach Time Out

Zu Lang: Die Anwendung stürzt ab, wenn ich diese über das Dateimenü beenden will kurz nachdem ich die Meldung erhalten habe, dass die Datenbank nicht verfügbar ist, als ich Daten in einen Rekord speichern wollte

Zu wenig Informationen: Programmabsturz

Zu ungenau: Problem wenn Datenbank nicht verfügbar

Der Titel wird so zum Such- und Referenzier-Kriterium wenn das Team über einen Bug diskutiert. Menschen können sich meistens Wörter auch besser merken als die Bug-Meldungsnummer. Sie merken sich also eher "Kann nicht auf Windows 2000 installiert werden" als die zugehörige Nummer 23423, die Mitglieder des Teams werden also diese Schlüsselwörter zur Suche nutzen.

Es ist schwer eine gute und direkte Überschrift zu entwickeln. Gehe davon aus, dass Du oft mehr Zeit für die Findung der Überschrift benötigen wirst, als für das Schreiben der restlichen Bug-Meldung. Stelle sicher, dass die Überschrift auch in den Ausdruck des Reports passt und auf dem Bildschirm nicht gescrollt werden muss. Der Titel muss nicht grammatikalisch perfekt sein, aber er muss direkt zum Punkt kommen.