Wskazówki dotyczące komunikatu o błędzie

Komunikat o błędzie to tekst, który jest wyświetlany w celu opisania problemu, który uniemożliwia użytkownikowi lub systemowi ukończenie zadania. Problem może spowodować uszkodzenie lub utratę danych. Inne typy komunikatów obejmują potwierdzenia, ostrzeżenia i powiadomienia. Wytyczne w tym temacie mają pomóc w pisaniu przejrzystych komunikatów o błędach, które są łatwe do zlokalizowania i przydatne dla klientów.

Źle napisane komunikaty o błędach mogą być źródłem frustracji dla użytkowników i mogą zwiększyć koszty pomocy technicznej. Dobrze napisany komunikat o błędzie zawiera następujące informacje dla użytkownika:

• Co się stało i dlaczego?
• Jaki jest wynik końcowy dla użytkownika?
• Co użytkownik może zrobić, aby zapobiec jego ponownemu wystąpieniu?

Długość tekstu nie jest problemem, o ile deweloper poprawnie obsługuje rozmiary. Ważne jest, aby użytkownik miał wszystkie informacje niezbędne do rozwiązania problemu. Jeśli komunikat ma wielu odbiorców, może być konieczne podanie oddzielnego tekstu dla administratorów, użytkowników końcowych i deweloperów.

Najlepsze rozwiązania

Poniżej przedstawiono sposoby ulepszania komunikatów o błędach:

• Unikaj warunków błędów. Jeśli możesz przewidzieć, że wystąpi błąd, gdy użytkownik wykona określoną akcję, zapisz ponownie kod, aby użytkownik nie mógł spowodować błędu.
• Napisz oddzielny komunikat o błędzie dla każdej znanej przyczyny błędu. Nie używaj pojedynczego, ogólnego komunikatu, aby wyjaśnić każdą możliwą przyczynę błędu, chyba że nie można określić przyczyny błędu, gdy wystąpi.
• Jasno określ problem i, jeśli będzie on pomocny dla użytkownika, wyjaśnij, co spowodowało problem. Jeśli to możliwe, zastąp ogólne komunikaty z zasobów tabeli komunikatów systemowych szczegółowym komunikatem specyficznym dla problemu.
• Podaj użytkownikowi rozwiązanie problemu. Jeśli rozwiązanie ma więcej niż jeden krok, zapoznaj się z tematem pomocy objaśnianym szczegółowo zadanie.
• Wyświetl tylko nazwę produktu, składnika lub kreatora na pasku tytułu komunikatu. Pomaga to użytkownikowi określić, gdzie występuje problem. Nie sumuj problemu na pasku tytułu ani nie dołączaj słowa "błąd".
• Nie używaj żargonu technicznego, używaj terminologii zrozumiałej dla odbiorców. Nie należy używać slangu ani skrótów.
• Użyj odpowiednich przycisków poleceń, takich jak OK, Anuluj, Tak, Nie i Ponów próbę. Można użyć kombinacji tych przycisków. Przyciski Tak i Nie muszą być zawsze używane w połączeniu i muszą być zawsze poprzedzone pytaniem.
  • Aby zatrzymać operację i zamknąć okno komunikatu, użyj przycisku Anuluj.
  • Aby zamknąć okno komunikatu, użyj przycisku Zamknij.
  • Aby uzyskać więcej informacji na temat przyczyny błędu, użyj przycisku Szczegóły.
  • Aby uzyskać więcej informacji na temat rozwiązania problemu, użyj przycisku Pomoc.
  • Jeśli w komunikacie znajduje się akcja użytkownika, użyj przycisku OK, aby zamknąć okno komunikatu.
  • przycisków Tak i Nie muszą być używane w połączeniu i muszą być zawsze poprzedzone pytaniem.
• Jeśli błąd jest błędem krytycznym, zapisz go w dzienniku zdarzeń .

Zagadnienia dotyczące stylu

• Używaj kompletnych, ale prostych zdań.
• Użyj czasu bieżącego, aby opisać warunki, które spowodowały problem lub stan, który nadal istnieje. Możesz użyć napiętej przeszłości, aby opisać odrębne zdarzenie, które miało miejsce w przeszłości.
• Zawsze, gdy jest to możliwe, używaj aktywnego głosu. Możesz użyć pasywnego głosu do opisania warunku błędu.
• Unikaj wielkich liter i wykrzykników.
• Nie należy sprawiać, że użytkownik czuje się z błędem, nawet jeśli problem jest wynikiem błędu użytkownika.
• Nie należy antropomorfizować. Nie oznaczaj, że programy lub sprzęt mogą myśleć lub czuć.
• Nie używaj potocznie używanych wyrazów ani fraz. Nie używaj terminów, które mogą być obraźliwe w niektórych kulturach.
• Nie należy składać kilku nounów bez dodawania przyimka lub podklasy, aby wyjaśnić znaczenie. Na przykład "Serwer katalogu usługi LDAP serwera lokacji" należy zmienić na "Serwer katalogu dla usługi LDAP serwera lokacji".
• Wstaw deskryptory przed terminem, aby wyjaśnić znaczenie zdania. Na przykład "Określ identyfikator infID, gdy właściwość Detect ma ustawioną wartość Nie"." należy zmienić na "Określ parametr InfID, gdy opcja Wykryj ma wartość Nie".
• Unikaj słowa "bad". Użyj bardziej opisowych terminów, aby poinformować użytkownika, co jest złe. Na przykład unikaj komunikatów, takich jak "Nieprawidłowy rozmiar". Zamiast tego poinformuj użytkownika, jakie kryteria należy użyć podczas określania rozmiaru.
• Unikaj słowa "proszę". Można go interpretować, aby oznaczać, że wymagana akcja jest opcjonalna.
• Umieść wyrazy zarówno w indeksie, jak i istotne dla centralnego znaczenia na początku ciągu komunikatu.