نموذج bug report
جاهز للنسخ.
نموذج تقرير الخطأ (bug report) الجيد يقود المطوّر من القراءة إلى إعادة إنتاج الخطأ في محاولة واحدة: ما حدث، وما كان ينبغي أن يحدث، وما الخطوات، وأين. انسخ النموذج أدناه إلى مستند أو استمارة أو متتبِّع مهام، أو اضبط الحقول نفسها على لوحة تقبل الملفات أيضًا.
نموذج تقرير الخطأ
سبعة أسئلة. اشترط العنوان والخطوات؛ ودع الباقي اختياريًا.
العنوان
ما الذي لا يعمل وأين. جملة واحدة.
مثال: تصدير CSV ينزّل ملفًا فارغًا
ما الذي حدث؟
ما تراه، في جملة أو جملتَين.
ما الذي كان ينبغي أن يحدث؟
ما كان ينبغي أن يجري بدلًا من ذلك.
خطوات إعادة الإنتاج
1.
2.
3.
كم مرة؟
كل مرة، أو أحيانًا، أو مرة واحدة.
أين؟
المتصفح أو إصدار التطبيق، ونظام التشغيل، والحساب أو مساحة العمل.
هل لديك ما تعرضه؟
لقطة شاشة، أو تسجيل شاشة، أو سجل، أو ملف HAR.
مثال على تقرير خطأ
النموذج نفسه، مكتملًا. المنتج والأرقام مختلَقة.
العنوان
تصدير CSV ينزّل ملفًا فارغًا
ما الذي حدث؟
بعد النقر على تصدير في صفحة التقارير نزل الملف،
لكنه لا يحوي إلا صف العناوين.
ما الذي كان ينبغي أن يحدث؟
ملف فيه 214 صفًا، كما يظهر في الجدول على الشاشة.
خطوات إعادة الإنتاج
1. افتح التقارير واختر آخر 30 يومًا.
2. رشّح حسب خطة «Scale».
3. انقر على تصدير، ثم CSV.
كم مرة؟
كل مرة مع تشغيل المرشّح. ومن دون مرشّح يعمل التصدير.
أين؟
Chrome 141 على macOS 15. مساحة العمل: northwind.
هل لديك ما تعرضه؟
export.csv (الملف الفارغ)، reports.har
لماذا كل حقل
- العنوان. ما الذي لا يعمل وأين، ليمكن إيجاد التقرير لاحقًا ولتلتقي التكرارات.
- ما الذي حدث؟ العرض بكلمات المبلِّغ، قبل أن يفسّره أحد.
- ما الذي كان ينبغي أن يحدث؟ نصف التقارير سوء فهم، وهذا السطر يُظهر أيّها.
- خطوات إعادة الإنتاج. الجزء الذي لا يستطيع المطوّر تخمينه. مرقَّمة، إجراء واحد في كل خطوة.
- كم مرة؟ «كل مرة» تشير إلى المنطق؛ و«أحيانًا» إلى التوقيت أو البيانات.
- أين؟ المتصفح والإصدار والحساب يضيّقون البحث أكثر من أيّ وصف.
- هل لديك ما تعرضه؟ التسجيل أو السجل يحلّ محلّ ثلاث فقرات.
كيف تجعل من النموذج استمارة للإبلاغ عن الأخطاء
ينبغي أن تسأل استمارة الإبلاغ عن الأخطاء أقل من النموذج. كل حقل إلزامي يكلّف بضعة تقارير، والتقرير المفقود يكلّف أكثر من التفصيل المفقود.
- اشترط العنوان وخطوات إعادة الإنتاج، ولا شيء غيرهما.
- اعرض في كل حقل مثالًا بوصفه نصًّا إرشاديًا، ليتبيّن مستوى التفصيل الذي تتوقعه.
- اعرض التقارير المشابهة قبل إرسال الاستمارة، ليُضاف صوت بدل تكرار.
- اسمح بإضافة الملفات بإفلاتها على الاستمارة.
- قل ما سيحدث بعد ذلك: أين سيظهر التقرير وكيف سيصل الجواب.
ما ترفقه بتقرير الخطأ
الأدلة تختصر الحوار. هذه الملفات تستحق أن تُطلب، ويحسم كل منها شيئًا مختلفًا.
- لقطة شاشة، مع كل ما يُرى.
- تسجيل شاشة بصيغة MP4، عندما يصعب وصف الخطوات بالكلمات.
- ملف HAR، عندما لا تُحمَّل الصفحة أو لا تحفظ أو لا تصدّر.
- سجل من وحدة التحكّم أو من الخادم بصيغة TXT أو LOG.
- الرسالة نفسها بصيغة EML، مع مشكلات التسليم والتنسيق.
- ملف CSV أو XLSX أو JSON الذي تعذّر استيراده، أو الذي خرج خاطئًا.
جمع تقارير الأخطاء على لوحة Kjerr
تستطيع لوحة Kjerr أن تطرح أسئلة النموذج وتحفظ الأدلة. ويرى الفريق ما هو جديد حيث تجري إدارة آراء العملاء.
- النموذج قابل للتعديل: أضف حقولك «خطوات إعادة الإنتاج» و«ما الذي كان ينبغي أن يحدث» و«أين»، حتى 10 حقول في المجموع، كل منها إلزامي أو اختياري، بنصه الإرشادي.
- حتى 5 ملفات بحجم 10 ميغابايت على كل تقرير وتعليق: صور وPDF وEML وTXT وLOG وCSV وJSON وHAR وZIP وDOCX وXLSX وPPTX وMP4.
- التقارير المشابهة تظهر أثناء كتابة العنوان، وبجانب كل واحدة زر تصويت.
- للوحة اختبار الجودة اجعل الوصول للأعضاء فقط واحصر تسجيل الدخول في نطاق بريد الشركة؛ وهو الإعداد نفسه الذي يصنع صندوق الاقتراحات الإلكتروني.
- عندما تتغيّر الحالة إلى Shipped، يصل بريد إلى المبلِّغ وكل المصوّتين.
- ليس متتبِّع مهام: لا مكلَّفين ولا مستويات خطورة ولا سبرنتات.
أسئلة وأجوبة مباشرة.
ما هو نموذج bug report؟
نموذج bug report (تقرير الخطأ) مجموعة ثابتة من الأسئلة تستخرج من كل تقرير الحقائق نفسها: ما حدث، وما كان ينبغي أن يحدث، وكيف يُعاد إنتاج الخطأ، وأين ظهر. به ينتقل المطوّر من القراءة إلى إعادة الإنتاج من دون جولة من الأسئلة التكميلية.
ما الذي ينبغي أن يحويه تقرير الخطأ؟
عنوانًا في جملة واحدة، ووصفًا لما حدث وما كان ينبغي أن يحدث، وخطوات مرقَّمة لإعادة الإنتاج، وكم مرة يظهر الخطأ، والبيئة، والأدلة مثل لقطة شاشة أو سجل. وإن أمكن اشتراط شيئَين فقط، فليكونا العنوان والخطوات.
ما الفرق بين تقرير الخطأ وطلب الميزة؟
يقول تقرير الخطأ إن المنتج لا يفعل ما يعد به. ويطلب طلب الميزة شيئًا لم يعد به المنتج أبدًا. ويحتاجان إلى أسئلة مختلفة؛ وللثاني استخدم نموذج طلب الميزة.
كيف أكتب خطوات إعادة الإنتاج جيدًا؟
ابدأ من حالة يستطيع كل واحد الوصول إليها، واكتب إجراءً واحدًا في كل سطر، واذكر القيم الدقيقة التي أُدخلت أو اختيرت. وتوقف عند الخطوة التي تظهر فيها المشكلة. وإن كانت خطوة ما لازمة أحيانًا فقط، فقل ذلك.
ما هو ملف HAR، وهل يستحق الإرفاق؟
ملف HAR سجل للطلبات التي أرسلتها صفحة ويب، يُحفظ من أدوات المطوّرين في المتصفح. أرفقه عندما لا تُحمَّل الصفحة أو لا تحفظ أو لا تصدّر. وتحقق منه أولًا: قد يحوي ملفات تعريف الجلسة وبيانات شخصية.
هل يحلّ Kjerr محلّ متتبِّع الأخطاء؟
لا. يجمع Kjerr التقارير، ويزيل التكرارات، ويُخبر المبلِّغين عند تغيّر الحالة. لا مكلَّفين ولا مستويات خطورة ولا سبرنتات، ولا مزامنة مع Jira وLinear. تستخدمه الفرق بابًا أماميًا، وتُبقي متتبِّع المهام خلفه.
صفحات ذات صلة
أعطِ مستخدميك جوابًا.
Kjerr مجاني خلال فترة الوصول المبكر، بكل الميزات ومن دون بطاقة ائتمان. وعندما تصل الخطط المدفوعة ستُحسب لكل مساحة عمل، لا لكل مقعد مشرف أبدًا.