So schreiben Sie einen Fehlerbericht: Eine Schritt-für-Schritt-Anleitung

Ein effektiver Fehlerbericht ist entscheidend für die Verbesserung der Benutzererfahrung Ihres Produkts. Ein klarer und detaillierter Fehlerbericht hilft den QA-Teams und Entwicklern, das Problem zu verstehen, es zu reproduzieren und schließlich zu beheben.

Was ist ein Fehlerbericht?

Ein Fehlerbericht ist ein Dokument, das Details zu einem Softwarefehler enthält. Es hilft Entwicklern, den Fehler zu beheben, indem es wichtige Informationen bereitstellt, z. B. wann und wie der Fehler auftritt. Der Fehler sollte in einem Fehlerverfolgungssystem wie GitHub aufgezeichnet werden, um seinen Status und seine Auswirkungen zu überwachen. Fehlerberichte helfen Produktbeteiligten dabei, die Behebung des Fehlers zu priorisieren, indem sie sie über seinen Schweregrad informieren. Sie sind ein wichtiger Bestandteil des Softwareentwicklungsprozesses.

Wie wichtig es ist, einen guten Fehlerbericht zu schreiben

Ein guter Fehlerbericht kann den Unterschied ausmachen, ob ein Fehler behoben wird oder nicht. Es kommuniziert die Benutzererfahrung und hilft dem gesamten Team, das Problem zu verstehen. Ein guter Fehlerbericht beschleunigt den Behebungsprozess und stellt sicher, dass sich der Fehler nicht negativ auf das Endprodukt auswirkt. Es ist ein entscheidender Teil des Softwareentwicklungslebenszyklus.

Kritische Elemente eines effektiven Fehlerberichts

1. Titel und Fehler-ID

Ein Fehlerbericht beginnt mit einem Titel und einer eindeutigen Fehler-ID. Normalerweise erstellt der Verfasser des Berichts den Titel, während Ihr Fehlerverfolgungssystem normalerweise automatisch die Fehler-ID generiert. Der Titel eines effektiven Fehlerberichts sollte eine klare, prägnante Zusammenfassung des Fehlers sein. In manchen Fällen wird auch die Art des Fehlers angegeben.

2. Anwendungsversion und Betriebssystem

Ein guter Fehlerbericht muss die Anwendungsversion und das Betriebssystem enthalten, die zum Zeitpunkt des Auftretens des Fehlers verwendet wurden. Es ist auch eine wertvolle Information zu wissen, ob der Fehler bei verschiedenen Versionen, Gerätetypen oder Betriebssystemen auftritt! Wenn Sie mit Snagit einen Screenshot erstellen, werden die Anwendungsversion und das Betriebssystem automatisch aufgezeichnet und können mithilfe des Capture-Info-Effekts auf dem Bild angezeigt werden.

3. Schritte zur Reproduktion des Fehlers

Die effektivsten Fehlerberichte enthalten Schritte zur Reproduktion des Fehlers. Diese Schritte sollten für Entwickler einfach zu befolgen und zu replizieren sein. Snagit kann Bilder oder Videoaufzeichnungen der zu reproduzierenden Schritte erstellen. Fügen Sie Ihren Screenshots Pfeile, Beschriftungen und Unschärfen hinzu, damit sich Entwickler auf die kritischen Elemente konzentrieren können, die zur Reproduktion des Fehlers erforderlich sind.

4. Tatsächliches vs. erwartetes Ergebnis

Die meisten Fehlerberichte beschreiben das tatsächliche Ergebnis des Fehlers, vergessen Sie jedoch nicht, das erwartete Ergebnis anzugeben. Das tatsächliche Ergebnis kann definiert werden als „was passiert, wenn der Fehler auftritt“, während das erwartete Ergebnis „was ohne den Fehler hätte passieren sollen“ ist. Es kann schwierig sein, den Fehler zu beheben, wenn die Entwickler das erwartete Ergebnis nicht kennen.

5. Screenshots und Videos

Screenshots und Bildschirmaufzeichnungen können einen Fehlerbericht erheblich verbessern, indem sie genau zeigen, wo ein Fehler auftritt, und visuelle Beweise liefern.

Zu den wichtigen Funktionen des Bildschirmaufnahmetools gehören:

• Screenshots, einschließlich Scroll-Aufnahme
  • Einblick in Screenshots für einen sichtbaren Bereich des Bildschirms: Es empfiehlt sich, ggf. die gesamte lange Webseite aufzunehmen. Dadurch wird sichergestellt, dass alle benötigten Informationen erfasst werden.
    • Im Gegensatz zu den meisten Aufnahmetools unterstützt Snagit das Aufwärts- und Abwärtsscrollen sowie das Aufzeichnen mit Links- und Rechtsscrollen.
• Bildbearbeitungswerkzeuge
  • Nutzen Sie Anmerkungstools wie Pfeile und Beschriftungen, um Screenshots zu verfeinern und sich auf relevante Details zu konzentrieren.
    • Snagit bietet effiziente Screenshot-Bearbeitungsfunktionen, einschließlich Magnify und Spotlight. Es bietet außerdem Unschärfe- und Schwärzungsfunktionen, um personenbezogene Daten zu verbergen.
• Bildschirmaufnahme
  • Videoaufzeichnungen veranschaulichen den Ablauf der Ereignisse, die zu einem Problem führen.
    • Im Gegensatz zu vielen anderen Alternativen erfasst Snagit Mausbewegungen und Systemaudio, um die bestmögliche Erfassung von Fehlerereignissen zu ermöglichen.
  • Fügen Sie für zusätzliche Klarheit während der Aufnahme einen Kommentar und eine Live-Zeichnung hinzu.
    • Snagit bietet Mikrofonerfassung und eine Vielzahl von Screen Draw-Markups, einschließlich automatischer Schrittanmerkungen. Für eine persönlichere Note ist auch eine optionale Webcam-Integration vorgesehen.
• Texterfassung und Metadatenerfassung.
  • Die effizientesten Produkte wie Snagit reduzieren den Zeitaufwand für die Eingabe von Bug-Tracking-Informationen, indem sie die Texterfassung (OCR) von Informationen vom Bildschirm erleichtern.
• Bibliotheks- und Dateiverwaltung
  • Mit Snagit können Sie Ihre Screenshots und Aufzeichnungen mit automatischen Metadaten und benutzerdefinierten Tags organisieren.
  • Bei jeder Erfassung können Metadaten wie URL und Zeitstempel kopiert und eingefügt werden, um bei der Erstellung von Fehlerberichten Zeit zu sparen.

Snagit ist die am besten bewertete Bildschirm- und Videoaufnahmesoftware auf dem Markt und wird von allen Fortune-500-Unternehmen verwendet.

Hören Sie auf, wiederholte Fragen zu stellen

Erstellen Sie mit Snagit anschauliche Videos und Anleitungen, sodass Sie Aufgaben nur einmal erklären müssen.

Probieren Sie es kostenlos aus

6. Fehlermeldungen und Protokolle

Stellen Sie sicher, dass Ihr Fehlerbericht alle durch den Fehler generierten Fehlermeldungen oder Protokolldateien enthält. Fehlermeldungen können schnell mit einem Screenshot erfasst werden, während Protokolldateien an Ihren Fehlerbericht angehängt werden können. Dadurch erhalten Entwickler wichtige technische Informationen zum Debuggen.

Beispiel für einen Fehlerbericht

Hier ist ein visuelles Beispiel für einen guten Fehlerbericht, der Schlüsselelemente wie Fehler-ID, Titel, Anwendungsversion, Betriebssystem, Schritte zur Reproduktion, erwartete und tatsächliche Ergebnisse, Screenshots und Fehlermeldungen enthält.

Was macht diesen Fehlerbericht effektiv?

Dies ist ein effektiver Fehlerbericht, da er einen beschreibenden Titel, genaue Schritte zur Reproduktion des Fehlers, einen kommentierten Screenshot und Systeminformationen enthält. Dieser Bericht bietet umfassende Informationen, um sicherzustellen, dass Entwickler das Problem klar verstehen und das Problem effizient beheben können.

Beachten Sie, dass der Screenshot mit einer Form versehen wurde, die den problematischen Link hervorhebt, und einer Beschriftung, die auf den Link mit weiteren Details im Textfeld verweist. Nicht verwandte Links auf beiden Seiten werden unscharf dargestellt, sodass der Entwickler den Fehler schnell finden kann und gleichzeitig den Kontext behält, in dem sich der Fehler befindet.

Häufige Fehler, die Sie beim Schreiben eines Fehlerberichts vermeiden sollten

1. Vage Beschreibungen

Ein effektiver Fehlerbericht sollte so spezifisch wie möglich sein, um Verwirrung zu vermeiden. Vermeiden Sie vage Beschreibungen wie „Die Schaltfläche funktioniert nicht.“ Eine bessere Beschreibung wäre: „Nach dem Klicken auf die rote Schaltfläche wird die Meldung ‚Fehler 404‘ angezeigt.“ Diese Klarheit stellt sicher, dass das gesamte Team ein umfassendes Verständnis für das Problem hat.

2. Fehlende Schritte zur Reproduktion

Die Entwickler benötigen möglicherweise Schritte zur Reproduktion des Fehlers, um das Problem zu verstehen oder zu beheben. Klare und präzise Schritte ersparen den Entwicklern Zeit und Frust. Erwägen Sie, eine Videoaufnahme von sich selbst zu machen, während Sie die Schritte zur Reproduktion durchgehen.

3. Visuelle Beweise vergessen

Ein häufiger Fehler in Fehlerberichten besteht darin, keine Screenshots oder Videos beizufügen. Es gibt nichts Effektiveres als den visuellen Nachweis von Screenshots, um das Verständnis und die Behebung des Fehlers zu beschleunigen.

Mit Snagit lassen sich schnell und einfach Screenshots und Bildschirmaufnahmen erstellen. Der Snagit-Editor kann Ihre Screenshots mit Anmerkungen versehen und die relevanten Informationen deutlich hervorheben. Alle vertraulichen Informationen aus dem endgültigen Screenshot können unkenntlich gemacht oder geschwärzt werden. Bildschirmaufzeichnungen sind eine weitere vielseitige Beweisform.

Bug-Reporting-Tools und Tracking-Systeme

Warum ein Bug-Tracking-System verwenden?

Ein Bug-Tracking-System hilft dem Entwicklungsteam, Fehler über verschiedene Teams und Entwicklungsstadien hinweg zu organisieren, zu verfolgen und zu priorisieren. Es weist eindeutige Tracking-Informationen zu, beispielsweise eine Titelfehler-ID. Es hilft QA-Teams zu verstehen, wie häufig Benutzer auf einen Fehler stoßen, und hilft Produktbeteiligten zu erkennen, wann die Arbeit zur Behebung eines Fehlers abgeschlossen ist. Diese Systeme können Einblicke liefern, die nach Fehlertyp und Fehlerpriorität segmentiert sind.

Wer nutzt Bug-Tracking-Tools?

Softwareentwicklungsteams verwenden diese Tools, um Fehler während des Entwicklungslebenszyklus zu identifizieren und zu beheben:

• Qualitätssicherungsteams (QA) verfolgen offiziell die während der Testphase festgestellten Mängel.
• Projektmanager nutzen diese Systeme, um die Risiken einer pünktlichen Lieferung zu überwachen.
• Der Kundensupport protokolliert von Endbenutzern gemeldete Probleme, um sicherzustellen, dass sie behoben werden.

Hauptmerkmale von Bug-Tracking-Tools

• Fehlererfassung – Möglichkeit, neue detaillierte Fehlerberichte zu protokollieren
• Fehlerberichte – Möglichkeit, Fehler anhand von Schweregraden oder anderen Metadaten zu finden
• Benutzerdefinierte Workflows – Unterstützung für teamspezifische Regeln, die zu ihren internen Prozessen wie Statusfortschritt und Governance passen
• Fehlerpriorisierung – Die Möglichkeit, Fehler zu priorisieren, zu entfernen und zurückzustellen
• Fehlerzuweisung – Die Möglichkeit, einem Teammitglied einen Fehler zuzuweisen
• Integrationsmöglichkeiten – Nahtlose Integration mit anderen Entwicklungstools, typischerweise Versionskontrollsystemen oder Projektmanagement-Tools
• Automatisierte Benachrichtigungen – Unterstützung bei der Benachrichtigung von Teammitgliedern über Statusänderungen durch Push-Benachrichtigungen
• Dashboards – Visuelle Einblicke in Fehlertrends und die Gesamtleistung des Teams

Vergleich von Bug-Tracking-Systemen

Zu den beliebten Bug-Tracking-Tools gehören Jira, Bugzilla, Trello und GitHub. Diese Tools ermöglichen die Erstellung von Fehlerberichten und die Zusammenarbeit zwischen Teammitgliedern. Weitere gängige Tools sind Redmine, MantisBT, Zoho Bug Tracker und Asana.

Die meisten dieser Systeme bieten begrenzte oder keine Unterstützung für die Erfassung von Screenshots und Bildschirmaufzeichnungen. Kunden verwenden normalerweise ein zusätzliches Produkt wie Snagit für eine robuste Bildschirmaufnahme.

• Für einige dieser Plattformen stehen jedoch Tools von Drittanbietern zur Verfügung, beispielsweise Capture für Jira von Zephyr, BetterBugs für Trello und eine Chrome-Erweiterung eines Drittanbieters namens Trello Capture.

Best Practices zum Erstellen von Fehlerberichten

1. Geben Sie detaillierte Reproduktionsschritte an

Klare Schritt-für-Schritt-Anweisungen zum Reproduzieren des Fehlers sind für einen effektiven Fehlerbericht von entscheidender Bedeutung. Dies trägt dazu bei, dass jeder im Team ein klares Verständnis des Problems hat. Entwickler werden die Schritte befolgen, um den Fehler zu reproduzieren und dann mögliche Lösungen untersuchen. Mehrere Personen, darunter die Qualitätssicherung oder verschiedene Entwicklungsteams, benötigen die Informationen, um das Problem zu reproduzieren.

2. Fügen Sie immer Screenshots und Bilder hinzu

Jeder Fehlerbericht sollte Screenshots, Bildschirmaufzeichnungen oder Videoclips enthalten. Snagit ist das ideale Tool zum Sammeln und Teilen visueller Informationen mit dem Entwicklungsteam. Pfeile, Formen, Beschriftungen und vieles mehr können zu einem Screenshot hinzugefügt werden, um wichtige Informationen hervorzuheben.

3. Testen Sie in mehreren Umgebungen

Tests in mehreren Umgebungen können wertvolle Informationen liefern – ist der Fehler nur bei einer bestimmten Anwendungsversion, einem bestimmten Gerätetyp oder einem bestimmten Betriebssystem aufgetreten? Mithilfe dieser Details können Entwickler feststellen, wann ein Fehler aufgetreten ist und wie er behoben werden kann.

4. Aktualisieren und überprüfen Sie Fehlerberichte regelmäßig

Es ist wichtig, Fehlerberichte regelmäßig zu überprüfen und zu aktualisieren. Wenn die QA-Teams neue Informationen zu einem Fehler finden, sollten sie diese in den vorhandenen Fehlerbericht aufnehmen. Dies stellt sicher, dass die Entwickler bei der Behebung des Fehlers über die genauesten Details verfügen.

Zusammenarbeit mit QA-Teams und Entwicklern

Klare Kommunikation ist der Schlüssel

Eine effektive Softwareentwicklung erfordert eine klare Kommunikation zwischen den QA-Teams und den Entwicklern. Um einen Fehler zu beheben, müssen die Entwickler das Problem verstehen und reproduzieren können. Entwickler sollten sich wohl fühlen, die QA-Teams nach Testtechniken zu fragen, und die QA-Teams sollten in der Lage sein, die Entwickler nach ihrem technischen Fachwissen zu fragen.

Wie Snagit die Zusammenarbeit mit visuellen Elementen unterstützen kann

Snagit ist ein leistungsstarkes Tool, das QA-Teams und Entwicklern hilft, effektiver zusammenzuarbeiten. Snagit kann schnell visuelle Berichte erstellen und teilen und sorgt so für eine klare Kommunikation und Zusammenarbeit zwischen Entwicklungsteams.

Abschluss

Effektive Fehlerberichte sind für die Softwareentwicklung von entscheidender Bedeutung und tragen dazu bei, qualitativ hochwertige Produkte sicherzustellen. Berücksichtigen Sie beim Verfassen eines Fehlerberichts detaillierte Reproduktionsschritte, Screenshots und Videoaufzeichnungen, Systeminformationen sowie erwartete und tatsächliche Ergebnisse.

Snagit ist das beste verfügbare Produkt, um hochwertige visuelle Darstellungen zu erstellen und das Verständnis und die Kommunikation im Fehlerbehebungsprozess zu verbessern.

Beschleunigen Sie Ihre Screenshot-Workflows

Verschwenden Sie keine Zeit mehr mit integrierten Snipping-Tools und probieren Sie Snagit aus!

Erfahren Sie mehr