So schreiben Sie einen Fehlertitel, der bei der Triage nicht untergeht
Der Titel eines Fehlers ist die eine Zeile, die die meisten lesen. Erfahren Sie, was hineingehört, was nicht, und wie Sie ihn vor dem Melden an einer Tracker-Liste testen.
Öffnen Sie einen vollen Tracker und sehen Sie sich die Listenansicht an. Sie sehen eine Zeile pro Ticket: eine ID, einen Status und einen Titel. Sonst nichts. In dieser Zeile wird ein Fehler angenommen, ignoriert, mit einem anderen Ticket zusammengeführt oder mit einer Rückfrage zurückgeschickt, und die Entscheidung fällt oft, bevor jemand die Beschreibung öffnet.
Der Titel leistet also mehr Arbeit als jede andere Zeile, die Sie schreiben. So wird er dem gerecht.
Was ein Titel leisten muss
Ein Titel hat in der Listenansicht drei Aufgaben.
- Sagen, wo. Der Bereich, der Bildschirm oder der Befehl, damit die richtige Person es bemerkt.
- Sagen, was falsch ist. Das Symptom, das Sie gesehen haben, nicht Ihre Theorie über die Ursache.
- Auffindbar sein. Wer nächsten Monat auf denselben Fehler stößt, sucht nach ein paar Worten. Ihr Titel sollte die Worte enthalten, die diese Person verwenden würde.
Eine Form, die funktioniert
Probieren Sie diese Reihenfolge: wo, dann was passiert ist, dann die Bedingung, auf die es ankommt.
`` Checkout: Promo-Code wird doppelt angewendet, wenn die Zurück-Taste benutzt wird Export: CSV ist leer, wenn der Datumsbereich über einen Jahreswechsel reicht Login: Fehler 500 wird nach Passwort-Reset im mobilen Web angezeigt ``
Jeder Titel nennt einen Bereich, beschreibt das Symptom und ergänzt die eine Bedingung, die diesen Fehler von ähnlichen unterscheidet. Ein Entwickler, der die Liste überfliegt, erkennt, welcher davon seiner ist.
Titel, die Sie teuer zu stehen kommen
| Titel | Was daran schiefgeht | |---|---| | „Fehler im Checkout“ | Nennt kein Symptom. Es könnte jedes Checkout-Ticket sein. | | „Export reparieren“ | Eine Aufgabe, kein Bericht. Er unterstellt eine Ursache und verbirgt die Belege. | | „Button funktioniert nicht“ | Welcher Button, und was heißt „funktioniert nicht“? | | „DRINGEND!!! App kaputt“ | Dringlichkeit gehört ins Prioritätsfeld, und „kaputt“ ist kein Symptom. | | „Sporadischer Absturz“ | Wo? Unter welchen Bedingungen? Er wird mit dem ähnlichsten Treffer zusammengeführt. |
Das Symptom beschreiben, nicht die Vermutung
„Cache nach dem Speichern nicht geleert“ ist eine Vermutung. „Alter Preis wird nach dem Speichern eines neuen weiter angezeigt“ ist das, was Sie gesehen haben. Liegen Sie mit Ihrer Vermutung falsch, schickt eine Vermutung im Titel den Entwickler zum falschen Code und macht das Ticket für jemanden, der dasselbe Symptom mit einer anderen Ursache sieht, schwerer auffindbar. Schreiben Sie Ihre Theorie in die Beschreibung, gekennzeichnet als Theorie.
Den Fehlertext aufnehmen, wenn es einen gibt
Hat das Produkt eine Meldung angezeigt, ist ein kurzes Zitat daraus der beste Suchbegriff, den Sie der nächsten Person geben können. Halten Sie es kurz und lassen Sie IDs, E-Mail-Adressen und alles Persönliche weg. „Zahlung schlägt mit ‚card declined‘ bei gültiger Karte fehl“ findet seine Zwillinge.
Den Titel vor dem Melden testen
Machen Sie zwei kurze Prüfungen.
- Lesen Sie ihn für sich allein. Decken Sie die Beschreibung ab. Könnte eine fremde Person erkennen, was wo falsch ist?
- Suchen Sie damit. Fügen Sie Ihren Titel in die Tracker-Suche ein. Erscheint ein früheres Ticket, lesen Sie es, bevor Sie melden. Findet Ihr Titel ein Ticket nicht, von dem Sie wissen, dass es existiert, ist der Titel jenes Tickets schwach, und Ihr Titel braucht vielleicht die Worte, die jenem fehlen. Unser Artikel zum Finden doppelter Fehler vor dem Melden behandelt die Suche selbst.
Halten Sie Titel kurz genug, um sie in einer Liste lesen zu können, und verschieben Sie Details in die Beschreibung. Ein Titel, der über mehrere Zeilen umbricht, enthält meist schon eine Beschreibung.
Wo BugIt ins Spiel kommt
Titel gelingen leicht, wenn man ruhig ist, und misslingen leicht, wenn man es eilig hat. Wenn Sie BugIt ein Problem in einer groben Notiz beschreiben, entwirft es einen Bericht mit einem Titel in dieser Form und durchsucht Ihren Tracker nach ähnlichen Tickets, bevor Sie den Entwurf sehen. Die Suche greift nur lesend zu. Sie prüfen den Entwurf, ändern den Titel, wenn Sie möchten, und BugIt schwärzt gängige personenbezogene Daten nach besten Kräften. Nichts wird in Ihren Tracker geschrieben, bevor Sie FILE IT eingeben.
Wie es funktioniert, sehen Sie unter taskivator.com/bugit und bugit.dev.
Das Wichtigste in Kürze
Schreiben Sie den Titel für die Listenansicht: wo, was passiert ist und die eine Bedingung, auf die es ankommt. Beschreiben Sie, was Sie gesehen haben, zitieren Sie die Fehlermeldung, falls es eine gibt, und suchen Sie mit Ihrem eigenen Titel, bevor Sie melden.