Hibaüzenetek irányelvei

A hibaüzenet olyan szöveg, amely egy olyan probléma leírására jelenik meg, amely megakadályozza, hogy a felhasználó vagy a rendszer elvégezze a feladatot. A probléma adatsérülést vagy adatvesztést okozhat. Az egyéb üzenettípusok közé tartoznak a megerősítések, a figyelmeztetések és az értesítések. A jelen témakörben szereplő irányelvek célja, hogy segítsenek egyértelmű hibaüzeneteket írni, amelyek könnyen honosíthatóak és hasznosak az ügyfelek számára.

A rosszul írt hibaüzenetek frusztrációt okozhatnak a felhasználók számára, és növelhetik a technikai támogatási költségeket. Egy jól megírt hibaüzenet a következő információkat nyújtja a felhasználónak:

• Mi történt és miért?
• Mi a felhasználó végeredménye?
• Mit tehet a felhasználó, hogy megakadályozza, hogy újra megtörténjen?

A szöveg hossza nem probléma, ha a fejlesztő megfelelően kezeli a pufferméreteket. Fontos, hogy a felhasználó rendelkezzen a probléma megoldásához szükséges összes információval. Ha egy üzenet több célközönséget tartalmaz, előfordulhat, hogy külön szöveget kell megadnia a rendszergazdáknak, a végfelhasználóknak és a fejlesztőknek.

Ajánlott eljárások

A következő módokon javíthatja a hibaüzeneteket:

• Kerülje a hibafeltételeket. Ha előre tudja jelezni, hogy hiba fog bekövetkezni, amikor egy felhasználó végrehajt egy adott műveletet, írja át a kódot, hogy a felhasználó ne okozhassa a hibát.
• Írjon egy külön hibaüzenetet a hiba minden ismert okához. Ne használjon egyetlen általános üzenetet a hiba minden lehetséges okának magyarázatára, kivéve, ha nem tudja megállapítani a hiba okát, amikor az bekövetkezik.
• Egyértelműen adja meg a problémát, és ha hasznos lesz a felhasználó számára, magyarázza el, hogy mi okozta a problémát. Amikor csak lehetséges, cserélje le a rendszer üzenettáblájának erőforrásaiból érkező általános üzeneteket egy, a problémára jellemző részletes üzenetre.
• Adja meg a felhasználónak a probléma megoldását. Ha a megoldás több lépéssel is rendelkezik, tekintse meg a súgótémakört, amely részletesen ismerteti a feladatot.
• Csak a termék, összetevő vagy varázsló nevét jelenítse meg az üzenet címsorában. Ez segít a felhasználónak meghatározni a probléma helyét. Ne foglalja össze a problémát a címsorban, és ne foglalja bele a "error" szót.
• Ne használjon technikai zsargont, használja a közönség által megértett terminológiát. Ne használjon szlenget vagy rövidítéseket.
• Használja a megfelelő parancsgombokat, például az OK, a Mégse, az Igen, a Nem és az Újrapróbálkozás gombot. A gombok kombinációit használhatja. Az Igen és a Nem gombot mindig együtt kell használni, és mindig egy kérdésnek kell megelőznie.
  • Egy művelet leállításához és az üzenetmező bezárásához használja a Mégse gombot.
  • Üzenetmező bezárásához használja a Bezárás gombot.
  • A hiba okával kapcsolatos további információkért használja a Részletek gombot.
  • A probléma megoldásáról a Súgó gombra kattintva kaphat további információt.
  • Ha az üzenet tartalmaz egy felhasználói műveletet, az OK gombbal zárja be az üzenetmezőt.
  • Igen és Nem gombokat kell egyszerre használni, és mindig egy kérdés előtt kell lennie.
• Ha a hiba kritikus hiba, írja be az eseménynaplóba.

Stílusokkal kapcsolatos szempontok

• Használjon teljes, de egyszerű mondatokat.
• Használja a jelenlegi feszültet a problémát okozó feltételek vagy a még létező állapot leírására. A múltbeli tense használatával leírhatja a múltban történt különböző eseményeket.
• Amikor csak lehetséges, használjon aktív hangot. A hibaállapot leírásához használhat passzív hangot.
• Kerülje a nagybetűs szöveget és a felkiáltójeleket.
• Ne érezze magát a felhasználó hibásnak, még akkor sem, ha a probléma egy felhasználói hiba eredménye.
• Ne anthropomorphize. Ne utaljon arra, hogy a programok vagy hardverek gondolkodhatnak vagy érezhetnek.
• Ne használjon köznyelvi szavakat vagy kifejezéseket. Ne használjon olyan kifejezéseket, amelyek bizonyos kultúrákban sértőek lehetnek.
• Ne adjon hozzá több főnevet anélkül, hogy előpozíciót vagy alklámot ad hozzá a jelentés tisztázásához. Például a "Site Server LDAP Service címtárkiszolgáló" értéket "A helykiszolgáló LDAP-szolgáltatásának címtárkiszolgálója" értékre kell módosítani.
• A mondat jelentésének tisztázásához szúrjon be leírókat egy kifejezés elé. Például az "InfID megadása, ha az észlelés nem értékre van állítva". Ezt a beállítást "Az InfID paraméter megadása, ha az Észlelés beállítás értéke Nem".
• Kerülje a "rossz" szót. Használjon leíróbb kifejezéseket, hogy elmondja a felhasználónak, mi a probléma. Kerülje például az olyan üzeneteket, mint a "Rossz méret". Ehelyett adja meg a felhasználónak, hogy milyen feltételeket használjon a méret megadásakor.
• Kerülje a "kérem" szót. Úgy értelmezhető, hogy a szükséges művelet nem kötelező.
• Helyezze el az indexben lévő és a központi jelentés szempontjából releváns szavakat az üzenetsztring elején.