Bagikan melalui

Pedoman Pesan Kesalahan

  • Artikel

Pesan kesalahan adalah teks yang ditampilkan untuk menjelaskan masalah yang telah terjadi yang mencegah pengguna atau sistem menyelesaikan tugas. Masalah ini dapat mengakibatkan kerusakan atau kehilangan data. Jenis pesan lainnya termasuk konfirmasi, peringatan, dan pemberitahuan. Panduan dalam topik ini dimaksudkan untuk membantu Anda menulis pesan kesalahan yang jelas yang mudah dilokalkan dan berguna bagi pelanggan.

Pesan kesalahan yang ditulis dengan buruk dapat menjadi sumber frustrasi bagi pengguna dan dapat meningkatkan biaya dukungan teknis. Pesan kesalahan yang ditulis dengan baik memberikan informasi berikut kepada pengguna:

  • Apa yang terjadi dan mengapa?
  • Apa hasil akhirnya untuk pengguna?
  • Apa yang dapat dilakukan pengguna untuk mencegahnya terjadi lagi?

Panjang teks tidak menjadi masalah selama pengembang menangani ukuran buffer dengan benar. Penting bahwa pengguna memiliki semua informasi yang diperlukan untuk menyelesaikan masalah. Jika pesan memiliki beberapa audiens, Anda mungkin perlu menyediakan teks terpisah untuk administrator, pengguna akhir, dan pengembang.

Praktik Terbaik

Berikut ini adalah cara untuk meningkatkan pesan kesalahan Anda:

  • Hindari kondisi kesalahan. Jika Anda dapat memprediksi bahwa kesalahan akan terjadi saat pengguna melakukan tindakan tertentu, tulis ulang kode Anda sehingga pengguna tidak dapat menyebabkan kesalahan.
  • Tulis pesan kesalahan terpisah untuk setiap penyebab kesalahan yang diketahui. Jangan gunakan satu pesan umum untuk menjelaskan setiap kemungkinan alasan kesalahan kecuali Anda tidak dapat menentukan penyebab kesalahan ketika terjadi.
  • Sebarkan masalah dengan jelas dan, jika akan membantu pengguna, jelaskan apa yang menyebabkan masalah. Jika memungkinkan, ganti pesan generik dari sumber daya tabel pesan sistem dengan pesan terperinci yang khusus untuk masalah tersebut.
  • Berikan solusi kepada pengguna untuk masalah tersebut. Jika solusi memiliki lebih dari satu langkah, lihat topik bantuan, jelaskan tugas secara rinci.
  • Tampilkan hanya nama produk, komponen, atau wizard di bilah judul pesan. Ini membantu pengguna menentukan di mana masalahnya. Jangan meringkas masalah di bilah judul atau sertakan kata "kesalahan".
  • Jangan gunakan jargon teknis, gunakan terminologi yang dipahami audiens Anda. Jangan gunakan bahasa gaul atau singkatan.
  • Gunakan tombol perintah yang sesuai, seperti OK, Batal, Ya, Tidak, dan Coba Lagi. Anda dapat menggunakan kombinasi tombol-tombol ini. Tombol Ya dan Tidak harus selalu digunakan dalam kombinasi dan harus selalu didahului oleh pertanyaan.
    • Untuk menghentikan operasi dan menutup kotak pesan, gunakan tombol Batalkan.
    • Untuk menutup kotak pesan, gunakan tombol Tutup.
    • Untuk memberikan informasi selengkapnya tentang penyebab kesalahan, gunakan tombol Detail.
    • Untuk memberikan informasi selengkapnya tentang solusi untuk masalah tersebut, gunakan tombol Bantuan.
    • Jika tindakan pengguna disertakan dalam pesan, gunakan tombol OK untuk menutup kotak pesan.
    • Ya dan Tidak ada tombol yang harus digunakan dalam kombinasi dan harus selalu didahului oleh pertanyaan.
  • Jika kesalahan adalah kesalahan penting, tulis ke log peristiwa .

Pertimbangan Gaya

  • Gunakan kalimat lengkap tetapi sederhana.
  • Gunakan present tense untuk menjelaskan kondisi yang menyebabkan masalah atau status yang masih ada. Anda dapat menggunakan past tense untuk menggambarkan peristiwa berbeda yang terjadi di masa lalu.
  • Gunakan suara aktif jika memungkinkan. Anda dapat menggunakan suara pasif untuk menjelaskan kondisi kesalahan.
  • Hindari teks huruf besar dan tanda seru.
  • Jangan membuat pengguna merasa salah meskipun masalahnya adalah akibat kesalahan pengguna.
  • Jangan anthropomorphize. Jangan menyiratkan bahwa program atau perangkat keras dapat berpikir atau merasakan.
  • Jangan gunakan kata atau frasa koloquial. Jangan gunakan istilah yang mungkin menyinggung dalam budaya tertentu.
  • Jangan menggabungkan beberapa kata benda tanpa menambahkan preposisi atau subklasul untuk mengklarifikasi arti. Misalnya, "server direktori Layanan LDAP Server Situs" harus diubah menjadi "Server direktori untuk Layanan LDAP Server Situs".
  • Sisipkan deskriptor sebelum istilah untuk mengklarifikasi arti kalimat. Misalnya, "Tentukan InfID saat Deteksi diatur ke Tidak." harus diubah menjadi "Tentukan parameter InfID saat opsi Deteksi diatur ke Tidak".
  • Hindari kata "buruk". Gunakan istilah yang lebih deskriptif untuk memberi tahu pengguna apa yang salah. Misalnya, hindari pesan seperti "Ukuran buruk". Sebagai gantinya, beri tahu pengguna kriteria apa yang akan digunakan saat menentukan ukuran.
  • Hindari kata "please". Ini dapat ditafsirkan berarti bahwa tindakan yang diperlukan bersifat opsional.
  • Tempatkan kata-kata yang berada dalam indeks dan relevan dengan arti pusat di awal string pesan.