it-swarm.com.de

Empfehlungen für gute Ressourcen zum Schreiben guter Fehlermeldungen

Es ist schwierig, gute Fehlermeldungen zu schreiben, die den Benutzern helfen, die Verwendung des Systems zu verstehen. Oft erhalten wir Fehlerberichte mit der Aufschrift "Fehlermeldung x ist verwirrend", was normalerweise zu einer langen Debatte im Team über die Umformulierung führt.

Gibt es gute Ressourcen zum Schreiben guter Fehlermeldungen?.

Ich suche

  • bücher
  • Gute Blogposts Artikel
  • papiere
  • forschungsergebnisse

Viele Designbücher erwähnen es, widmen ihm aber nur einige Absätze.

20
Mark

Defensives Design für das Web: So verbessern Sie Fehlermeldungen, Hilfe, Formulare und andere Krisenpunkte (2004) von 37signals, obwohl 2011 veraltet, zeigt Ihnen verschiedene Beispiele für eine schlechte Fehlerbehandlung, einschließlich Kopieren und erklärt, was falsch ist und wie man sich verbessern kann. Es nennt all dies "Kontingenzdesign" (der Titel des Buches ist vom Konzept des defensiven Fahrens inspiriert). Einige der extrahierten Muster sind noch heute relevant. Insbesondere Amazon war damals in diesem Bereich führend.

Das größte Problem, das ich damals beim Lesen mitgenommen habe, war, dass sich Ihre Website wie ein Verkäufer in einem Geschäft verhalten sollte: Wenn ich verloren bin oder keinen Artikel finde, stellt mir der Verkäufer Fragen, um mir zu helfen finde, wonach ich suche, während die meisten Websites nur "Nicht gefunden" sagen und das war's. Hier ist ein Auszug aus dem Eröffnungskapitel:

Dieses Buch zeigt Ihnen, wie Sie mithilfe des Notfalldesigns die Benutzerfreundlichkeit Ihrer Website verbessern können. Sie lernen Folgendes:

  • Was ist Notfalldesign und warum ist es wichtig?
  • 40 Richtlinien, die Ihnen helfen, Fehler zu vermeiden und Kunden zu retten, wenn etwas schief geht
  • So machen Sie die Fehlerbehebung und -verhütung zu einem Teil Ihres langfristigen Entwurfsprozesses
  • So bewerten Sie das Notfalldesign Ihrer Site, damit Sie sich auf die Bereiche konzentrieren können, die am dringendsten Hilfe benötigen

Insgesamt ist das Buch hilfreich beim Entwerfen der Fehlerbehandlung in Ihrer Website oder App, aber es gibt auch einige gute Punkte, die speziell zum Kopieren gemacht wurden. Ab Kapitel 2, "Zeigen Sie das Problem: Zeigen Sie offensichtliche Fehlermeldungen und Warnungen an":

Eine gute Fehlermeldung informiert einen Kunden sofort:

  • Dass ein Fehler aufgetreten ist
  • Was ist der Fehler?
  • Wie man sich erholt

Das Kapitel enthält eine Vielzahl von Beispielen (aus dem Jahr 2003) von Websites (von denen viele nicht mehr existieren). Jeder Diskussionspunkt enthält Beispiele für Websites, die Dinge falsch machen und warum, und Beispiele für Websites, die Dinge gut machen und warum.

11
Rahul

Ich suchte auch nach guten Ressourcen zum Schreiben effektiver Fehlermeldungen. Die nützlichsten Ressourcen, die ich gefunden habe, stammen von Microsoft:

Ich habe auch festgestellt, dass das Microsoft Manual of Style einige interessante Teile enthält, die auf Fehlermeldungen angewendet werden können. Es lohnt sich zu lesen, wenn Sie an der Erstellung von Dokumentation interessiert sind, aber es ist eine lange (und wahrscheinlich langweilige) Lektüre, wenn Sie nur daran interessiert sind, wie Sie gute Fehlermeldungen schreiben.

Da ich die meiste Zeit damit verbringe, Fehlermeldungen zu schreiben und zu überprüfen, denke ich persönlich, dass eine gute Fehlermeldung drei Teile haben sollte:

  • Das Problem
  • Die Ursache
  • Die Lösung

Konzentrieren Sie sich zuerst darauf, diese drei Teile aufzuschreiben, und bearbeiten Sie dann den Text, um ihn kleiner und menschlicher zu machen. Ich habe einen Beitrag zum Schreiben von Fehlermeldungen geschrieben, aber wenn Sie diese drei Teile in Ihre Nachricht übernommen haben, haben Sie bereits 80% des Problems gelöst .

0
jff