BugIt4 Min. Lesezeit

Eine Vorlage für Fehlerberichte, die Entwickler wirklich lesen

Eine kopierbare Vorlage für Fehlerberichte, wofür jeder Teil da ist, und die Gewohnheiten, die aus einer vagen Beschwerde ein Ticket machen, das ein Entwickler beheben kann.

Eine Fehlerbericht-Karte mit sechs beschrifteten Teilen: Titel, Schritte zur Reproduktion, erwartet, tatsächlich, Umgebung und Belege.

Zwei Sätze kosten Softwareteams mehr Zeit, als sie verdienen. Der erste lautet: „Bei mir funktioniert es.“ Der zweite: „Können Sie mehr Details schicken?“

Beide Sätze verraten einen Fehlerbericht, in dem etwas fehlt. Die meldende Person hat das Problem klar gesehen. Der Entwickler sieht es nicht, also wartet das Ticket, die meldende Person wendet sich anderer Arbeit zu, und wenn die Antwort kommt, erinnern sich nur noch wenige an die Details.

Die Lösung ist kein längerer Bericht. Es ist ein Bericht mit den richtigen Teilen, in einer Form, die sich überfliegen lässt. Hier sind eine Vorlage, der Zweck jedes Teils und ein paar Gewohnheiten, mit denen sie funktioniert.

Die Vorlage zum Einfügen

Kopieren Sie sie in das Beschreibungsfeld Ihres Trackers oder in eine Vorlage, die Ihr Team gemeinsam nutzt.

``` Titel: [Bereich] Was schiefgeht, in wenigen Worten

Schritte zur Reproduktion

  1. Wo Sie beginnen (Seite, Bildschirm, Befehl)
  2. Was Sie tun
  3. Was Sie als Nächstes tun
  4. Der Schritt, an dem es schiefgeht

Erwartet Was hätte passieren sollen.

Tatsächlich Was stattdessen passiert ist, einschließlich der angezeigten Meldung.

Umgebung Version oder Build, Plattform, Browser oder Betriebssystem, Kontotyp und wie oft es auftritt.

Belege Log-Auszug, Screenshot, Request-ID oder eine kurze Aufzeichnung.

Schweregrad und Begründung Wie schlimm es ist und wen es betrifft.

Verwandte Tickets Tickets, die ähnlich aussehen oder denselben Bereich berühren. ```

Sie sieht aus wie ein Formular, und genau darum geht es. Ein Entwickler, der ein Ticket in dieser Form öffnet, weiß schon vor dem ersten gelesenen Wort, wo er jede Antwort findet.

Warum jeder Teil seinen Platz verdient

Der Titel ist ein Symptom, keine Theorie. „Checkout-Summe ignoriert den Jahrestarif nach Anwenden eines Promo-Codes“ sagt der Person bei der Triage genau, wo sie suchen muss. „Preisfehler“ sagt ihr nichts. Ein Tag wie [Checkout] am Anfang hilft, eine lange Liste zu überfliegen und zusammengehörige Tickets zu sortieren.

Die Schritte sind nummeriert und beginnen an einer Stelle, die auch Fremde erreichen. Nennen Sie die echten Werte, die Sie verwendet haben, etwa den Promo-Code oder den Tarif, denn Fehler lieben konkrete Eingaben. Dann tun Sie etwas, das die meisten auslassen: Führen Sie Ihre eigenen Schritte vor dem Melden noch einmal aus. Wiederholt sich der Fehler nicht, sagen Sie das und beschreiben Sie, wie oft er aufgetreten ist. Diese Ehrlichkeit erspart einem Entwickler einen Nachmittag.

Erwartet und Tatsächlich klären die Frage früh. Ohne „Erwartet“ muss der Entwickler raten, was Sie wollten. Ohne „Tatsächlich“ muss er raten, was Sie gesehen haben. Zwei kurze Zeilen ersparen zwei Vermutungen.

Die Umgebung beantwortet die erste Frage eines Entwicklers. Welcher Build war das? Die Version zeigt ihm, ob das Problem in dem Code, den er geöffnet hat, noch existiert. Ergänzen Sie die Plattform und eine Kontoeinstellung, die das Verhalten ändern könnte, und sagen Sie, wie oft es auftritt. Ein Problem, das jedes Mal auftritt, und eines, das nur ab und zu auftritt, führen zu unterschiedlichen Untersuchungen.

Belege schlagen Beschreibungen. Ein gekürztes Log mit der Fehlerzeile und ein paar Zeilen drumherum ist mehr wert als ein Absatz Erklärung. Ein Screenshot sollte genug vom Bildschirm zeigen, damit man sieht, wo Sie sind. Bevor Sie etwas anhängen, suchen Sie nach personenbezogenen Daten und Geheimnissen wie E-Mail-Adressen und Zugriffstokens, und entfernen Sie sie.

Der Schweregrad braucht eine Begründung. „Hoch“ allein ist eine Meinung. „Hoch: Ein zahlender Kunde sieht die falsche Summe“ erlaubt dem Team, das Ticket im Vergleich zu allem anderen in der Warteschlange einzuordnen.

Ein ausgefülltes Beispiel

Hier ist die Vorlage mit echtem Inhalt.

``` Titel: [Checkout] SAVE20 wendet nach dem Wechsel auf jährlich den Monatspreis an

Schritte zur Reproduktion

  1. Pro-Tarif in den Warenkorb legen (monatlich)
  2. Abrechnungszeitraum auf jährlich umstellen
  3. Promo-Code SAVE20 anwenden
  4. Bestellübersicht ansehen

Erwartet 20 % Rabatt auf den Jahrespreis.

Tatsächlich 20 % Rabatt auf den Monatspreis, angezeigt als Jahressumme.

Umgebung Produktion, Web, Build 2.14.1, tritt jedes Mal auf.

Belege TypeError: plan.period is undefined at applyPromo (pricing.ts:88)

Schweregrad und Begründung Hoch: Ein zahlender Kunde sieht die falsche Summe. ```

Achten Sie darauf, was ein Entwickler damit in der ersten Minute anfangen kann. Er kennt den Bereich, kann den Schritten folgen, und die Fehlerzeile verweist auf eine Datei. Eine Rückfrage ist nicht nötig.

Gewohnheiten, die Berichte nützlich halten

Kleine Gewohnheiten zählen mehr als eine perfekte Vorlage.

  • Ein Fehler pro Ticket. Zwei Probleme in einem Bericht werden zu unterschiedlichen Zeiten behoben, also melden Sie sie getrennt und verknüpfen Sie sie.
  • Suchen Sie, bevor Sie melden. Vielleicht hat schon jemand dasselbe Problem gemeldet. Wenn Sie Ihre Belege zu diesem Ticket hinzufügen, bleibt die Geschichte an einem Ort.
  • Sagen Sie, was Sie versucht haben. Wenn ein Neuladen, ein anderer Browser oder ein anderes Konto das Ergebnis ändert, ist das ein Hinweis, der eine Zeile wert ist.
  • Bleiben Sie sachlich. Ein Bericht ist nicht der Ort für Frust. Fakten führen schneller zu einer Lösung als Gefühle.
  • Aktualisieren Sie das Ticket, wenn Sie mehr wissen. Eine neue Build-Nummer oder eine enger eingegrenzte Schrittfolge ist wertvoll, auch einen Tag später.

Wo BugIt ins Spiel kommt

Dass man in dieser Form schreiben sollte, leuchtet jedem ein, am Ende eines langen Tages fällt es aber schwer. Genau diese Lücke schließt BugIt. BugIt ist ein QA-Agent, der in dem Assistenten läuft, den Sie bereits nutzen. Sie beschreiben in einem groben Satz, was kaputt ist, und BugIt schreibt den Bericht in der Ausdrucksweise Ihres Teams: Titel, Schritte, erwartet und tatsächlich, Schweregrad und die Belege, die Sie ihm gegeben haben. Es schwärzt gängige personenbezogene Daten nach besten Kräften, daher lesen Sie den Entwurf, bevor etwas davon weitergegeben wird. Sie prüfen jeden Entwurf, bevor er angelegt wird, und nichts wird in Ihren Tracker geschrieben, bevor Sie FILE IT eingeben.

Wie es funktioniert, sehen Sie unter bugit.dev, mehr über das Produkt finden Sie unter taskivator.com/bugit.

Das Wichtigste in Kürze

Ein guter Fehlerbericht beantwortet die Fragen des Entwicklers, bevor er sie stellt: wo, wie, was Sie erwartet haben, was passiert ist, auf welchem Build und wie schlimm es ist. Nutzen Sie die Vorlage, prüfen Sie Ihre Schritte einmal, hängen Sie gekürzte Belege an und begründen Sie Ihren Schweregrad. Die paar Minuten, die Sie investieren, kommen als schnellere Fehlerbehebungen zurück.

Jetzt verfügbarQA-Agent für Ihren KI-Assistenten

BugIt

Deutsch