Dies ist eine Anleitung zum Verfassen effektiver Fehlerberichte in Discourse, um die Chancen auf eine Behebung der Fehler zu maximieren.
Erforderliche Benutzerstufe: Jeder kann einen Fehler melden
Das Schreiben eines guten Fehlerberichts ist entscheidend, um dem Discourse-Team zu helfen, Probleme effizient zu beheben. Diese Anleitung führt dich durch die Schritte und Best Practices, um sicherzustellen, dass dein Fehlerbericht klar, prägnant und umsetzbar ist.
Zusammenfassung
In dieser Dokumentation behandeln wir:
- Die Bedeutung der Bereitstellung von reproduzierbaren Schritten und spezifischen Details
- Wie man das Problem und das erwartete Verhalten beschreibt
- Best Practices für die Meldung auf verschiedenen Plattformen
- Die Einhaltung eines angemessenen Tons in deinem Bericht
- Häufige Fallstricke und Lösungen
Schritte zum Verfassen eines effektiven Fehlerberichts
Priorität/Schweregrad
Bestimme die Dringlichkeit der Fehlerbehebung. Obwohl jeder seine Probleme schnell gelöst haben möchte, reserviere die höchste Priorität für kritische Probleme, die die Funktionalität erheblich beeinträchtigen.
Plattform
Gib 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
Repliziere den Fehler nach Möglichkeit auf mehreren Plattformen, um sein Vorhandensein zu bestätigen.
Beschreibung
Sei prägnant. Beschreibe das Problem einfach und ohne unnötige Details. Trenne verschiedene Probleme, wenn sie einzeln gemeldet werden können. Ein klares Beschreibungsformat umfasst:
Tatsächliches Ergebnis: Was passiert?
Erwartetes Ergebnis: Was hätte passieren sollen?
Vermeide Annahmen darüber, was der Leser bereits weiß. Sei explizit darüber, was gesehen oder geschehen sein sollte.
Reproduzierbare Schritte
Stelle sicher, dass der Fehler konsistent reproduziert werden kann. Schreibe Schritt-für-Schritt-Anweisungen, beginnend mit dem Startbildschirm von Discourse. Wenn der Fehler zufällig auftritt, gib an, wie oft er auftritt (z. B. 1 von 10 Versuchen). Füge bei UI/UX-bezogenen Fehlern zur Klarheit Screenshots oder Videos hinzu.
Ton
Bewahre einen respektvollen und höflichen Ton bei. Verwende den Fehlerbericht nicht, um Frustration auszudrücken. Jede toxische Sprache oder Verhalten kann dazu führen, dass dein Bericht verzögert oder ignoriert wird.
Vorlage
Verwende diese Vorlage, um schnell ein neues Fehlerberichtsthema zu erstellen:
Priorität/Schweregrad:
Plattform:
Beschreibung:
Reproduzierbare Schritte:
Best Practices
- Im sicheren Modus reproduzieren: Versuche vor der Meldung, das Problem im Sicheren Modus von Discourse zu reproduzieren, wenn du vermutest, dass Anpassungen die Ursache sein könnten.
- Annahmen hinterfragen: Fehlerberichte entstehen oft aus falschen Annahmen. Stelle auch in deinem Bericht Annahmen in Frage und kläre sie auf.
- Sei detailliert: Bei schwer fassbaren oder seltenen Fehlern liefere so viele Details wie möglich. Füge alles hinzu, was deiner Meinung nach relevant sein könnte, wie Fehlermeldungen oder Protokolldateien.
Häufige Probleme und Lösungen
Problem: Der Fehler kann nicht konsistent reproduziert werden.
Lösung: Dokumentiere die Umgebung und die Bedingungen, unter denen der Fehler auftritt. Notiere etwaige Muster oder Gemeinsamkeiten.
Problem: Keine Reaktion auf einen Fehlerbericht.
Lösung: Stelle sicher, dass dein Bericht detailliert, aber prägnant ist und in einem höflichen Ton verfasst wurde.
Häufig gestellte Fragen (FAQs)
F: Was, wenn ich keine Zeit für einen detaillierten Bericht habe?
A: Es ist dennoch hilfreich, einen Bericht mit den vorhandenen Informationen zu eröffnen. Gib an, dass du ihn später mit weiteren Details aktualisieren wirst.
F: Wo sollte ich meinen Fehlerbericht veröffentlichen?
A: Verwende die passende Kategorie – Fehlerberichte gehören in die Kategorie Contribute > Bug.