Sdílet prostřednictvím

Pokyny k chybové zprávě

  • Článek

Chybová zpráva je text zobrazený k popisu problému, ke kterému došlo, který uživateli nebo systému brání v dokončení úkolu. Příčinou problému může být poškození nebo ztráta dat. Mezi další typy zpráv patří potvrzení, upozornění a oznámení. Pokyny v tomto tématu vám pomůžou psát jasné chybové zprávy, které jsou snadno lokalizovány a užitečné pro zákazníky.

Špatně napsané chybové zprávy mohou být zdrojem frustrace pro uživatele a mohou zvýšit náklady na technickou podporu. Dobře napsaná chybová zpráva poskytuje uživateli následující informace:

  • Co se stalo a proč?
  • Jaký je konečný výsledek pro uživatele?
  • Co může uživatel udělat, aby se zabránilo jeho opětovnému vzniku?

Délka textu není problém, pokud vývojář zpracovává správné velikosti vyrovnávací paměti. Je důležité, aby uživatel měl všechny informace potřebné k vyřešení problému. Pokud zpráva obsahuje více cílových skupin, možná budete muset poskytnout samostatný text správcům, koncovým uživatelům a vývojářům.

Osvědčené postupy

Chybové zprávy můžete vylepšit následujícími způsoby:

  • Vyhněte se chybám. Pokud můžete předpovědět, že dojde k chybě, když uživatel provede určitou akci, přepište kód tak, aby uživatel nemohl chybu způsobit.
  • Zapište samostatnou chybovou zprávu pro každou známou příčinu chyby. Nepoužívejte jedinou obecnou zprávu k vysvětlení všech možných důvodů chyby, pokud nemůžete určit příčinu chyby, když k ní dojde.
  • Uveďte problém jasně a pokud bude pro uživatele užitečné, vysvětlete, co problém způsobilo. Pokud je to možné, nahraďte obecné zprávy ze systémových prostředků tabulky zpráv podrobnou zprávou, která je specifická pro daný problém.
  • Poskytněte uživateli řešení problému. Pokud řešení obsahuje více než jeden krok, přečtěte si téma nápovědy, které podrobně vysvětluje úkol.
  • V záhlaví zprávy se zobrazí jenom název produktu, komponenty nebo průvodce. To pomáhá uživateli určit, kde je problém. Neshrňujte problém v záhlaví nebo uveďte slovo "error".
  • Nepoužívejte technický žargon, používejte terminologii, kterou cílová skupina rozumí. Nepoužívejte slang ani zkratky.
  • Použijte příslušná příkazová tlačítka, například OK, Zrušit, Ano, Ne a Opakovat. Můžete použít kombinace těchto tlačítek. Tlačítka Ano a Ne musí být vždy použita v kombinaci a musí vždy předcházet otázce.
    • Pokud chcete zastavit operaci a zavřít okno se zprávou, použijte tlačítko Zrušit.
    • Pokud chcete zavřít okno se zprávou, použijte tlačítko Zavřít.
    • Pokud chcete zadat další informace o příčině chyby, použijte tlačítko Podrobnosti.
    • Pokud chcete poskytnout další informace o řešení problému, použijte tlačítko nápovědy.
    • Pokud je do zprávy zahrnuta akce uživatele, zavřete okno zprávy tlačítkem OK.
    • tlačítka Ano a Ne musí být použita v kombinaci a musí být vždy předcházet otázce.
  • Pokud je chyba kritická, zapište ji do protokolu událostí .

Aspekty stylu

  • Použijte úplné, ale jednoduché věty.
  • Aktuální čas použijte k popisu podmínek, které způsobily problém nebo stav, který stále existuje. Pomocí minulých časů můžete popsat jedinečnou událost, ke které došlo v minulosti.
  • Kdykoli je to možné, používejte aktivní hlas. Pasivní hlas můžete použít k popisu chybového stavu.
  • Vyhněte se velkým písmenům textu a vykřičníkům.
  • Neuciťujte uživatele v chybě, i když je problém výsledkem chyby uživatele.
  • Anthropomorfizujte. Neznamená to, že programy nebo hardware si mohou myslet nebo cítit.
  • Nepoužívejte kolizní slova ani fráze. Nepoužívejte termíny, které mohou být urážlivé v určitých kulturách.
  • Nezkompilujte několik podstatných jmen bez přidání předložky nebo podklíče k objasnění významu. Například adresářový server služby LDAP serveru lokality by měl být změněn na "Adresářový server pro službu LDAP serveru lokality".
  • Vložte popisovače před termín, abyste objasnili význam věty. Pokud je například možnost Zjistit nastavená na Hodnotu Ne, měla by být změněna na "Zadejte parametr InfID, pokud je možnost Zjistit nastavena na Ne".
  • Vyhněte se slovu "špatné". Pomocí popisnějších termínů řekněte uživateli, co je špatně. Vyhněte se například zprávám typu Chybná velikost. Místo toho uživateli řekněte, jaká kritéria se mají použít při zadávání velikosti.
  • Vyhněte se slovu "prosím". Dá se interpretovat tak, že povinná akce je nepovinná.
  • Na začátku řetězce zprávy umístěte slova, která jsou v indexu i relevantní pro centrální význam.