Dies ist eine Anleitung zum Verfassen effektiver Fehlerberichte in Discourse, um die Chancen auf eine Fehlerbehebung zu maximieren.
Erforderliches Benutzerniveau: Jeder kann einen Fehler melden
Writing a good bug report is essential to help the Discourse team fix issues efficiently. This guide will walk you through the steps and best practices to ensure your bug report is clear, concise, and actionable.
Zusammenfassung
In dieser Dokumentation behandeln wir:
- Die Wichtigkeit, reproduzierbare Schritte und spezifische Details anzugeben
- Wie man das Problem und das erwartete Verhalten beschreibt
- Best Practices für die Meldung auf verschiedenen Plattformen
- Beibehaltung eines angemessenen Tons in Ihrem Bericht
- Häufige Fallstricke und Lösungen
Schritte zum Verfassen eines effektiven Fehlerberichts
Priorität/Schweregrad
Bestimmen Sie die Dringlichkeit der Fehlerbehebung. Obwohl jeder seine Probleme schnell gelöst haben möchte, reservieren Sie die höchste Priorität für kritische Probleme, die die Funktionalität erheblich beeinträchtigen.
Plattform
Geben Sie immer die Umgebung an, in der der Fehler beobachtet wurde. Dazu gehören:
- Gerätetyp (Desktop, Mobilgerät, Touchscreen, Tablet)
- Betriebssystem und dessen Version
- Webbrowser und dessen Version
Wenn möglich, reproduzieren Sie den Fehler auf mehreren Plattformen, um dessen Vorhandensein zu bestätigen.
Beschreibung
Seien Sie prägnant. Beschreiben Sie das Problem einfach und ohne unnötige Details. Trennen Sie verschiedene Probleme, wenn sie einzeln gemeldet werden können. Ein klares Beschreibungsformat beinhaltet:
Tatsächliches Ergebnis: Was passiert?
Erwartetes Ergebnis: Was hätte passieren sollen?
Vermeiden Sie Annahmen darüber, was der Leser bereits weiß. Seien Sie explizit, was hätte gesehen oder passieren sollen.
Reproduzierbare Schritte
Stellen Sie sicher, dass der Fehler konsistent reproduziert werden kann. Schreiben Sie schrittweise Anweisungen, beginnend auf der Startseite von Discourse. Wenn der Fehler zufällig auftritt, geben Sie an, wie oft er auftritt (z. B. 1 von 10 Versuchen). Fügen Sie bei UI/UX-bezogenen Fehlern Screenshots oder Videos zur Verdeutlichung hinzu.
Ton
Behalten Sie einen respektvollen und höflichen Ton bei. Vermeiden Sie es, den Fehlerbericht zur Äußerung von Frustration zu verwenden. Jede toxische Sprache oder Verhaltensweise kann dazu führen, dass Ihr Bericht verzögert oder ignoriert wird.
Vorlage
Verwenden Sie diese Vorlage, um schnell ein neues Thema für einen Fehlerbericht zu erstellen:
Priorität/Schweregrad:
Plattform:
Beschreibung:
Reproduzierbare Schritte:
Best Practices
- In Safe Mode reproduzieren: Versuchen Sie vor der Meldung, das Problem im Safe Mode von Discourse zu reproduzieren, wenn Sie vermuten, dass Anpassungen dies verursachen könnten.
- Annahmen hinterfragen: Fehlerberichte resultieren oft aus falschen Annahmen. Hinterfragen und klären Sie auch in Ihrem Bericht alle Annahmen, die Sie möglicherweise haben.
- Detailliert sein: Bei schwer fassbaren oder seltenen Fehlern geben Sie so viele Details wie möglich an. Fügen Sie alles hinzu, was Sie für relevant halten, wie Fehlermeldungen oder Protokolldateien.
Häufige Probleme und Lösungen
Problem: Der Fehler kann nicht konsistent reproduziert werden.
Lösung: Dokumentieren Sie die Umgebung und die Bedingungen, unter denen der Fehler auftritt. Notieren Sie Muster oder Gemeinsamkeiten.
Problem: Keine Antwort auf einen Fehlerbericht.
Lösung: Stellen Sie sicher, dass Ihr Bericht detailliert, aber prägnant und in einem höflichen Ton verfasst ist.
FAQs
F: Was ist, wenn ich keine Zeit für einen detaillierten Bericht habe?
A: Es ist trotzdem hilfreich, einen Bericht mit den Ihnen vorliegenden Informationen zu eröffnen. Geben Sie an, dass Sie ihn später mit weiteren Details aktualisieren werden.
F: Wo soll ich meinen Fehlerbericht posten?
A: Verwenden Sie die entsprechende Kategorie – Fehlerberichte gehören in die Kategorie bug.