هذا دليل لكتابة تقارير أخطاء فعالة في Discourse لزيادة فرص إصلاح الأخطاء.
مستوى المستخدم المطلوب: يمكن لأي شخص الإبلاغ عن خطأ
تعد كتابة تقرير خطأ جيد أمرًا ضروريًا لمساعدة فريق Discourse في إصلاح المشكلات بكفاءة. سيرشدك هذا الدليل خلال الخطوات وأفضل الممارسات لضمان أن يكون تقرير الخطأ الخاص بك واضحًا وموجزًا وقابلاً للتنفيذ.
ملخص
في هذه الوثيقة، سنغطي:
- أهمية تقديم خطوات قابلة للاستنساخ وتفاصيل محددة
- كيفية وصف المشكلة والسلوك المتوقع
- أفضل الممارسات للإبلاغ عبر منصات مختلفة
- الحفاظ على نبرة مناسبة في تقريرك
- العوائق الشائعة والحلول
خطوات كتابة تقرير خطأ فعال
الأولوية/الخطورة
حدد مدى إلحاح إصلاح الخطأ. في حين أن الجميع يريد حل مشكلاتهم بسرعة، احتفظ بأعلى أولوية للمشكلات الحرجة التي تؤثر بشكل كبير على الوظائف.
المنصة
حدد دائمًا البيئة التي لوحظ فيها الخطأ. ويشمل ذلك:
- نوع الجهاز (سطح المكتب، الهاتف المحمول، شاشة اللمس، الجهاز اللوحي)
- نظام التشغيل وإصداره
- متصفح الويب وإصداره
حيثما أمكن، قم باستنساخ الخطأ عبر منصات متعددة لتأكيد وجوده.
الوصف
كن موجزًا. صف المشكلة ببساطة ودون تفاصيل غير ضرورية. افصل بين المشكلات المختلفة إذا كان يمكن الإبلاغ عنها بشكل فردي. يتضمن تنسيق الوصف الواضح ما يلي:
النتيجة الفعلية: ما الذي يحدث؟
النتيجة المتوقعة: ما الذي كان ينبغي أن يحدث؟
تجنب الافتراضات حول ما يعرفه القارئ بالفعل. كن صريحًا بشأن ما كان يجب رؤيته أو حدوثه.
خطوات قابلة للاستنساخ
تأكد من إمكانية استنساخ الخطأ باستمرار. اكتب تعليمات خطوة بخطوة بدءًا من الشاشة الرئيسية لـ Discourse. إذا ظهر الخطأ عشوائيًا، فحدد عدد مرات حدوثه (على سبيل المثال، 1 من أصل 10 محاولات). بالنسبة للأخطاء المتعلقة بواجهة المستخدم/تجربة المستخدم، أضف لقطات شاشة أو مقاطع فيديو للتوضيح.
النبرة
حافظ على نبرة محترمة ومهذبة. تجنب استخدام تقرير الخطأ للتعبير عن الإحباط. يمكن أن يؤدي أي لغة أو سلوك سام إلى تأخير تقريرك أو تجاهله.
القالب
استخدم هذا القالب لبدء موضوع تقرير خطأ جديد بسرعة:
الأولوية/الخطورة:
المنصة:
الوصف:
خطوات قابلة للاستنساخ:
أفضل الممارسات
- الاستنساخ في الوضع الآمن: قبل الإبلاغ، حاول استنساخ المشكلة في الوضع الآمن لـ Discourse إذا كنت تشك في أن التخصيصات قد تكون هي السبب.
- الاستفسار عن الافتراضات: غالبًا ما تنبع تقارير الأخطاء من افتراضات خاطئة. حتى في تقريرك، استفسر ووضح أي افتراضات قد تكون لديك.
- كن مفصلاً: بالنسبة للأخطاء الغامضة أو النادرة، قدم أكبر قدر ممكن من التفاصيل. أدرج أي شيء تعتقد أنه قد يكون ذا صلة، مثل رسائل الخطأ أو ملفات السجل.
المشكلات الشائعة والحلول
المشكلة: غير قادر على استنساخ الخطأ باستمرار.
الحل: وثّق البيئة والظروف التي يظهر فيها الخطأ. لاحظ أي أنماط أو أوجه تشابه.
المشكلة: نقص الاستجابة لتقرير الخطأ.
الحل: تأكد من أن تقريرك مفصل ولكنه موجز ومكتوب بنبرة مهذبة.
الأسئلة الشائعة
س: ماذا لو لم يكن لدي وقت لتقرير مفصل؟
ج: لا يزال من المفيد فتح تقرير بالمعلومات المتوفرة لديك. أشر إلى أنك ستقوم بتحديثه بتفاصيل إضافية لاحقًا.
س: أين يجب أن أنشر تقرير الخطأ الخاص بي؟
ج: استخدم الفئة المناسبة - يجب أن تذهب تقارير الأخطاء إلى فئة bug.