Ein Problem triagieren

BeeWare erhält regelmäßig Problemberichte von Benutzern, die Probleme haben. Wenn ein neues Problem gemeldet wird, muss dieser Bericht triagiert werden - das heißt, wir brauchen jemanden, der den Bericht liest, die vom Meldenden bereitgestellten Informationen aufnimmt und versucht, das beschriebene Problem zu reproduzieren.

Leider sind die Problemberichte zwar in der Regel gut gemeint, aber oft unvollständig oder verwirrend. Der Zweck des Triage-Prozesses ist es, die Lücken des ursprünglichen Berichts zu füllen. Das bedeutet, dass wir entweder genügend Details generieren, um bestätigen zu können, wie das Problem reproduziert werden kann, oder um zu bestätigen, dass der ursprüngliche Berichterstatter sich in seinem Bericht geirrt hat.

Die Behandlung eines Problems bedeutet nicht, dass Sie es beheben müssen. Je nach Problem muss bei der Triage nicht einmal Code geschrieben werden. Sie können ein Problem mit sehr wenig Wissen über BeeWare triagieren, da Sie in der Lage sein sollten, die im Bericht enthaltenen Schritte zu befolgen und das beschriebene Problem zu reproduzieren.

Beitrag zur Problemtriage

Das Problem reproduzieren

Man kann ein Problem nicht beheben, wenn man es nicht von vornherein hat. Daher ist die Reproduktion des Problems eine Voraussetzung für seine Behebung. In der Softwarebranche werden Probleme üblicherweise als "Bugs" bezeichnet, und Probleme werden oft als "Fehlerberichte" bezeichnet.

Jemand hat einen Fehlerbericht eingereicht. Sie müssen überprüfen, ob die Schritte, die der Berichterstatter beschreibt, zu dem gemeldeten Fehler führen. Können Sie das gleiche Ergebnis reproduzieren, indem Sie genau das tun, was in dem Bericht beschrieben wurde? Wenn Sie das nicht können, müssen Sie herausfinden, warum.

Fehler im Code

Im Idealfall haben Sie die gleiche Konfiguration wie die Person, die den Fehler gemeldet hat, Sie folgen den Schritten und können den Fehler wie beschrieben reproduzieren. In vielen Fällen wird es jedoch nicht so einfach sein. Viele Fehlerberichte enthalten nur vage Erklärungen und eine vage Reihe von Bedingungen. Das Problem ist, dass sich viele Fehler je nach den beteiligten Bedingungen unterscheiden, einschließlich der Art der Interaktion mit ihnen, verschiedener Vorbedingungen, des Betriebssystems, der Betriebssystemversion, der CPU-Architektur oder ob der Rechner des Benutzers alt und langsam oder neu und schnell ist. Je mehr Informationen wir über die Situation haben, in der der Fehler auftritt, desto besser. Versuchen Sie, die vom Berichterstatter angegebenen Bedingungen zu reproduzieren. Wenn Sie dazu nicht in der Lage sind, kann Ihr nächster Schritt darin bestehen, weitere Informationen von der Person anzufordern, die den Fehler gemeldet hat.

Der beste Weg, einen Fehler zu reproduzieren, ist das kleinstmögliche Beispiel, bei dem das Problem noch auftritt. In den meisten Fällen werden die Meldenden kein minimal praktikables Beispiel angeben; wenn sie überhaupt ein Beispiel angeben, wird es direkt aus ihrer "realen" Anwendung kopiert. Ihr Ziel ist es, den Bericht auf die einfachste mögliche Form zu reduzieren, die das Problem aufzeigt. Der beste Reproduktionsfall ist das kleinstmögliche Programm. Diese Reduktion ist an sich schon hilfreich, weil sie das eigentliche Problem aufzeigt. Jeder kann das minimale Beispiel nehmen, es ausführen und den beschriebenen Fehler beobachten.

Fehler in der Dokumentation

Fehler in der Dokumentation können sich auf unterschiedliche Weise äußern. Es gibt Probleme mit der Formatierung, die zu Darstellungsproblemen führen. Manchmal ist es nicht einmal ein Fehler, sondern die Person hat die Dokumentation falsch gelesen oder einen echten Fehler gemacht. Das bedeutet aber nicht unbedingt, dass die Dokumentation nicht fehlerhaft ist. Der Inhalt kann unklar oder ungenau sein und Raum für Verwirrung oder Fehlinterpretationen lassen. Es ist möglich, dass ein Konzept, das besprochen werden sollte, nicht besprochen wird, weil es völlig undokumentiert ist.

Wenn ein Fehler in der Dokumentation gemeldet wird, sollten Sie überprüfen, ob das gemeldete Problem tatsächlich noch besteht. Im Falle von Rendering-Problemen müssen Sie die Dokumentation erstellen, um zu sehen, ob Sie das Problem reproduzieren können. Bei inhaltlichen Problemen müssen Sie überprüfen, ob noch niemand eine Aktualisierung eingereicht hat.

Aktualisieren Sie die Ausgabe

Der letzte Schritt im Triage-Prozess besteht darin, Ihre Erkenntnisse zu dokumentieren, indem Sie einen Kommentar zu dem Problem hinterlassen.

Wenn Sie in der Lage sind, das Problem genau wie beschrieben zu reproduzieren, ist das alles, was Sie sagen müssen. Hinterlassen Sie einen Kommentar, in dem Sie bestätigen, dass Sie dasselbe Problem haben, und zwar genau so, wie es der ursprüngliche Berichterstatter beschreibt.

Wenn Sie in der Lage sind, zusätzlichen Kontext zu liefern, geben Sie Details zu diesem Kontext an. Dazu könnte gehören, dass Sie das Problem auf einem anderen Betriebssystem oder mit einer anderen Version der betroffenen Software reproduzieren können, oder alles andere, was vom ursprünglichen Bericht abweicht.

Wenn im ursprünglichen Bericht Details fehlten, die Sie zur Reproduktion des Problems benötigten, fügen Sie diese Details hinzu. Dazu gehören z. B. Angaben zum Betriebssystem oder zur Version, die der ursprüngliche Bericht nicht enthielt, vollständigere Protokolle oder Stack Traces oder klarere Anweisungen zur genauen Abfolge der Vorgänge, die zur Reproduktion des Problems erforderlich sind. Wenn Sie eine einfachere Methode zur Reproduktion des Problems entwickelt haben (oder der ursprüngliche Berichterstatter keinen Reproduktionsfall angegeben hat), können Sie Details zu dieser Reproduktionsmethode angeben.

Wenn Sie das Problem nicht reproduzieren können, hinterlassen Sie ebenfalls einen Kommentar und beschreiben Sie darin, was Sie versucht haben. Zu wissen, wo ein Problem nicht auftritt, ist fast genauso wichtig wie zu wissen, wo es auftritt, da dies dabei hilft, mögliche Ursachen einzugrenzen. Wenn Sie eine Theorie haben, warum Sie das Problem nicht reproduzieren können – beispielsweise, wenn Sie glauben, dass es sich um einen Anwendungsfehler handelt oder dass das Problem durch ein kürzlich durchgeführtes Betriebssystem-Update behoben wurde –, fügen Sie diese Vermutung Ihrem Kommentar hinzu.

Schließlich können Sie dem Kernteam noch Empfehlungen geben. Wenn Sie der Meinung sind, dass der ursprüngliche Bericht fehlerhaft ist, schlagen Sie vor, dass das Problem geschlossen werden sollte; wenn Sie eine Theorie über die Ursache des Problems haben, können Sie diese ebenfalls vorschlagen. Ihre Kommentare helfen dem Kernteam dabei, den nächsten Schritt zur Lösung des Problems zu finden.