Verwendet jemand einen Styleguide für Fehlermeldungen?

Question

Ich habe festgestellt, dass Fehlermeldungen in einer Handvoll gängiger Stile geschrieben werden. Entweder in formvollendeten, zwanglosen Sätzen oder in verkürzten passiven Sätzen, die nicht immer einen vollständigen Satz bilden. Letzteres scheint die üblichere zu sein - obwohl vielleicht nicht so häufig wie die zufällige Mischung von Stilen, die ich in vielen Anwendungen sehe.

Enthält jemand Fehlermeldungen in seinem Style Guide? Ich bin mehr gespannt Meinungen auf der konsequenten grammatische Konstruktion dieser Dinge als über den Inhalt von ihnen, die bereits been discussed.

Answer 1

Sowohl die iPhone Human Interface Guidelines und die Apple Human Interface Guidelines enthält Abschnitte über Warnungen hat. Die Windows User Experience Interaction Guidelines haben Informationen für einige verschiedene Arten von Dialogen, einschließlich Fehlermeldungen

(iPhone)

Wie Sie den gewünschten Alarm Titel komponieren:

• den Titel kurz genug halten auf einer einzigen Zeile angezeigt werden, wenn möglich. Eine lange Warnung Titel ist schwierig für Leute schnell zu lesen, und es könnte abgeschnitten werden oder erzwingen die Warnung Nachricht zu blättern.
• Vermeiden Sie Einzelwortüberschriften, die keine nützlichen Informationen enthalten, wie als "Fehler" oder "Warnung".
• Verwenden Sie nach Möglichkeit ein Satzfragment. Eine kurze, informative Aussage ist oft einfacher zu als ein vollständiger Satz zu verstehen.
• Zögern Sie nicht negativ zu sein. Leute verstehen, dass die meisten Warnungen ihnen über Probleme erzählen oder sie über gefährliche Situationen warnen. Es ist besser, negativ und direkt als zu sein, ist es positiv aber schief.
• Vermeiden Sie "Sie", "Ihr", "Ich" und "Mein" so oft wie möglich. Manchmal kann Text, der Menschen direkt identifiziert kann mehrdeutig sein und kann sogar als eine Beleidigung interpretiert werden.
• Verwenden Titel-Stil Kapitalisierung und nicht endend Zeichensetzung, wenn:
• Der Titel ein Satzfragment besteht
• Der Titel eines einzigen Satz, der nicht eine Frage Kapitalisierung
• Verwendung Satz-Stil und eine Endung Frage Markieren Sie, wenn der Titel aus einem einzigen Satz besteht das ist eine Frage. Im Allgemeinen in Betracht ziehen, eine Frage für eine Warnung verwenden Titel, wenn Sie vermeiden können, eine Nachricht hinzufügen.
• Verwenden Sie Satz-Stil Großschreibung und entsprechende Endzeichensetzung für jeden Satz, wenn der Titel besteht aus zwei oder mehr Sätze. Ein Zwei-Satz-Zeichensatz sollte selten notwendig sein, obwohl Sie es betrachten können, wenn es Ihnen ermöglicht, das Hinzufügen einer Nachricht zu vermeiden.

Wenn Sie bieten eine optionale Alarmmeldung:

• erstellen kurzen, vollständigen Satz, die Satz-Stil Kapitalisierung verwendet und entsprechende Endung Zeichensetzung.
• Vermeiden Sie es, eine Nachricht zu erstellen, die zu lang ist. Wenn möglich, halten Sie die Nachricht kurz genug, um auf einer oder zwei Zeilen angezeigt zu werden. Wenn die Nachricht zu lang ist, scrollt , was kein guter Benutzer ist Erfahrung.

Vermeiden Sie Ihre Alarmtext mit Beschreibungen, welche Taste zu Hahn, wie Verlängerung „Tippen Sie auf die Informationen zu sehen.“ Idealerweise ist die Kombination von eindeutigen Alarmtext und logische Tastenbeschriftungen gibt den Menschen genug Informationen zu verstehen, die Situation und ihre Auswahl. Allerdings , wenn Sie eine ausführliche Anleitung zur Verfügung stellen müssen, folgen diese Richtlinien:

• Seien Sie sicher, dass das Wort „tap“ (nicht „touch“ oder „Klick“ oder „wählen“) zu beschreiben die Auswahl Aktion verwenden .
• Fügen Sie keinen Schaltflächentitel in Anführungszeichen ein, aber behalten Sie die Großschreibung bei.

-

(Mac)

Warnmeldung Text. Dieser Text in hervorgehobener (fettgedruckter) Systemschrift stellt eine kurze, einfache Zusammenfassung des Fehlers oder der Bedingung dar, mit der die Warnung aufgerufen wurde. Dies sollte ein vollständiger Satz sein; oft wird es als eine Frage dargestellt. Weitere Informationen finden Sie unter "Schreiben von Warnmeldungen".

Informativer Text. Dieser Text erscheint in der kleinen Systemschrift und bietet eine ausführlichere Beschreibung der Situation, ihrer Konsequenzen und Möglichkeiten, um aus ihr herauszukommen. Zum Beispiel ist eine Warnung, dass eine Aktion nicht rückgängig gemacht werden kann, eine angemessene Verwendung von informativem Text.

Eine gute Warnmeldung gibt eindeutig an, wodurch die Warnung ausgelöst wurde und was der Benutzer dagegen tun kann. Drücken Sie alles im Vokabular des Benutzers aus.

Um die Warnung wirklich nützlich zu machen, geben Sie einen Vorschlag darüber, was der Benutzer in Bezug auf die aktuelle Situation tun kann. Auch wenn die Warnung als Benachrichtigung für den Benutzer dient und keine weiteren Maßnahmen erforderlich sind, sollten Sie so viele Informationen bereitstellen, wie zur Beschreibung der Situation erforderlich sind.

-

(Microsoft)

Die Eigenschaften der guten Fehlermeldungen

Im Gegensatz zu den früheren schlechten Beispiele, gute Fehlermeldungen haben:

• Ein Problem. Gibt an, dass ein Problem aufgetreten ist.
• Eine Ursache. Erklärt, warum das Problem aufgetreten ist.
• Eine Lösung. Stellt eine Lösung bereit, mit der Benutzer das Problem beheben können.

Zusätzlich gute Fehlermeldungen sind in einer Weise präsentiert, die:

• Relevant. Die Nachricht stellt ein Problem dar, das den Benutzern wichtig ist.
• Umsetzbar. Benutzer sollten entweder eine Aktion ausführen oder ihr Verhalten als das Ergebnis der Nachricht ändern.
• Benutzerzentriert. Die Nachricht beschreibt das Problem in Bezug auf Zielbenutzer Aktionen oder Ziele, nicht in Bezug darauf, was der Code ist unzufrieden mit.
• Kurz. Die Nachricht ist so kurz wie möglich, aber nicht kürzer.
• Löschen. Die Nachricht verwendet eine einfache Sprache, so dass die Zielbenutzer problemlos Problem und Lösung verstehen können.
• Spezifisch. Die Nachricht beschreibt das Problem mit der spezifischen Sprache , die spezifische Namen, Standorte und Werte der beteiligten Objekte angibt.
• Höflich. Benutzer sollten nicht beschuldigt oder dazu gebracht werden, sich dumm zu fühlen.
• Selten. Wird selten angezeigt. Häufig angezeigte Fehlermeldungen sind ein Zeichen für schlechtes Design.