نص رسالة الخطأ - أفضل الممارسات

Question

نحن نقوم بتغيير بعض النص لرسائل الخطأ القديمة المكتوبة بشكل سيئ.ما هي بعض الموارد لأفضل الممارسات لكتابة رسائل خطأ جيدة (خاصة لنظام التشغيل Windows XP/Vista).

Answer 1

فيما يتعلق بصياغة رسائل الخطأ الخاصة بك، أوصي بالرجوع إلى أدلة الأنماط التالية لتطبيقات Windows:

• إرشادات تجربة مستخدم Windows, ، وعلى وجه التحديد القسم الخاص برسائل الخطأ هنا.
• دليل مايكروسوفت للأسلوب

Answer 2

أفضل الممارسات النهائية هي منع المستخدم من التسبب في الأخطاء في المقام الأول.

لا تخبر المستخدمين بأي شيء لا يهتمون به؛رمز الخطأ 5064 لا يعني شيئًا لأي شخص.لا تخبرهم أنهم ارتكبوا خطأً ما؛عدم السماح بذلك في المقام الأول.لا تلومهم، لا سيما على الأخطاء التي ارتكبها برنامجك.وقبل كل شيء، عندما تكون هناك مشكلة، أخبرهم بكيفية إصلاحه حتى يتمكنوا من المضي قدمًا وإنجاز بعض الأعمال.

Answer 3

يجب أن تكون رسالة الخطأ الجيدة:

• كن غير مزعج (لا توجد شاشة زرقاء أو شاشة موت صفراء)
• امنح المستخدم التوجيه لتصحيح المشكلة (بمفرده إن أمكن، أو بمن يمكنه الاتصال للحصول على المساعدة)
• إخفاء هراء المبرمج الباطني عديم الفائدة (لا تقل، "حدث استثناء مرجعي فارغ في السطر 45")
• كن وصفيًا دون أن تكون مطولًا.مجرد معلومات كافية لإخبار المستخدم بما يحتاج إلى معرفته وليس أكثر.

أحد الأشياء التي بدأت القيام بها هو إنشاء رقم فريد أعرضه في رسالة الخطأ وأكتبه في ملف السجل حتى أتمكن من العثور على الخطأ في السجل عندما يرسل لي المستخدم لقطة شاشة أو يتصل بي ويقول، "أنا حصلت على خطأ.تقول رقمي المرجعي هو 0988-7634"

Answer 4

لأسباب أمنية، لا تقدم معلومات النظام الداخلي التي لا يحتاجها المستخدم.
مثال تافه:عند الفشل في تسجيل الدخول، لا تخبر المستخدم إذا كان اسم المستخدم خاطئًا أو كلمة المرور خاطئة؛وهذا لن يؤدي إلا إلى مساعدة المهاجم على القوة الغاشمة للنظام.بدلاً من ذلك، فقط قل "مجموعة اسم المستخدم/كلمة المرور غير صالحة" أو شيء من هذا القبيل.

Answer 5

قم دائمًا بتضمين اقتراحات لمعالجة الخطأ.

Answer 6

حاول اكتشاف طريقة لكتابة برنامجك بحيث يصحح المشكلة لهم.

Answer 7

بالنسبة لأي إدخال مستخدم (سلاسل، وأسماء ملفات، وقيم، وما إلى ذلك)، قم دائمًا بعرض القيمة الخاطئة مع محددات حولها (علامات الاقتباس، والأقواس، وما إلى ذلك).على سبيل المثال

تعذر العثور على اسم الملف الذي أدخلته:"somefile.txt"

يساعد هذا في إظهار أي مسافات بيضاء/أحرف إرجاع قد تكون تسللت ويقلل بشكل كبير من استكشاف الأخطاء وإصلاحها والإحباط.

Answer 8

1. تجنب رسائل الخطأ المتطابقة الواردة من أماكن مختلفة؛حدد المعلمة باستخدام الملف: السطر إن أمكن، أو استخدم سياقًا آخر يتيح لك، كمطور، تحديد مكان حدوث الخطأ بشكل فريد.
2. تصميم آلية تتيح سهولة التوطين خاصة إذا كان منتجاً تجارياً.
3. إذا كانت رسائل الخطأ مرئية للمستخدم، فاجعلها جملًا كاملة وذات معنى ولا تفترض معرفة وثيقة بالرمز؛تذكر أنك دائمًا قريب جدًا من المشكلة، لكن المستخدم ليس كذلك.إذا كان ذلك ممكنًا، قم بإرشاد المستخدم حول كيفية المتابعة ومن يجب الاتصال به وما إلى ذلك.
4. يجب أن يكون لكل خطأ رسالة إن أمكن؛إذا لم يكن الأمر كذلك، فحاول وتأكد من أن جميع مسارات حل الأخطاء تصل في النهاية إلى رسالة خطأ تلقي الضوء على ما حدث.
   
   أنا متأكد من أنه ستكون هناك إجابات جيدة أخرى هنا ...

Answer 9

يمكن بالفعل قراءة الرسائل الأقصر.

كلما طالت رسالة الخطأ، قلّت قراءة المستخدم.ومع ذلك، حاول إعادة صياغة الكود حتى تتمكن من إزالة الاستثناءات إذا كانت هناك استجابة واضحة.حاول أن يكون لديك فقط استثناءات تحدث بناءً على أشياء خارجة عن سيطرة المستخدم أو التحكم في التعليمات البرمجية الخاصة بك.

أفضل رسالة استثناء هي تلك التي لا يتعين عليك عرضها أبدًا.

Answer 10

خطأ معالجة دائما أفضل من الخطأ إعداد التقارير, ، ولكن بما أنك تقوم بتعديل رسائل الخطأ وليس بالضرورة الكود، فإليك بعض الاقتراحات:

المستخدمون يريدون الحلول، وليس المشاكل.ساعدهم في معرفة ما يجب فعله بعد حدوث خطأ، حتى لو كانت الرسالة بسيطة مثل "الرجاء إغلاق النافذة الحالية وإعادة محاولة الإجراء."

أنا أيضًا معجب كبير بالتسجيل المركزي للأخطاء.تأكد من أن السجل قابل للفحص بواسطة الإنسان والكمبيوتر.لا يخبرك المستخدمون دائمًا بالمشكلات التي يواجهونها، خاصة إذا كان من الممكن "حلها"، لذا يمكن أن يساعدك السجل في معرفة الأشياء التي تحتاج إلى إصلاح.

إذا كان بإمكانك التحكم في مربع حوار الخطأ بسهولة، فيمكنك الحصول على مربع حوار يعرض رسالة لطيفة وقابلة للقراءة مع زر "تفاصيل" لإظهار رقم الخطأ وتتبعه وما إلى ذلك.يمكن أن تكون مساعدة كبيرة في حل المشكلات في الوقت الفعلي أيضًا.

Answer 11

ينطبق دعم تعدد اللغات على جميع أنواع الرسائل، ولكنه يميل إلى النسيان في حالة رسائل الخطأ.

Answer 12

أود أن لا أخبر المستخدم بالمعلومات الباطنية غير المفيدة مثل رموز الخطأ الرقمية.ومع ذلك، أود أن أتابع ذلك بالقول إنه يجب تسجيل هذه المعلومات بالتأكيد لاستكشاف الأخطاء وإصلاحها بواسطة أشخاص أكثر ذكاءً من الناحية التقنية.