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