تخط وانتقل إلى المحتوى الرئيسي

متطلبات تقارير الأخطاء

كيف أوثّق تقرير خطأ بشكل صحيح وما هي معايير Test IO؟

Nikola Jonic avatar
بقلم: Nikola Jonic
تم إجراء التحديث أمس

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

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

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

  • يجب أن يكون الرابط (URL) هو الرابط المنسوخ من متصفحك للصفحة التي تم فيها تفعيل الخطأ.

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

  • يجب أن يتكون الناتج الفعلي من جملة أو أكثر تشرح ما حدث بعد آخر إجراء. يمكنك أيضًا إضافة نتائج الإجراءات السابقة إذا كانت ضرورية لفهم الخطأ. يجب ألا يكون نفس العنوان.

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

  • إذا كان هناك مرفق مطلوب لتقريرك، يجب ألا تنسى إرفاقه.

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

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

نموذج الأخطاء

بعد اختيار الميزة، سيظهر لك نموذج الأخطاء بالكامل. على سبيل المثال، نموذج الأخطاء الوظيفية يبدو كالتالي:

يجب عليك ملء كل حقل في نموذج الأخطاء بالمعلومات الصحيحة والمحددة وفقًا لمعايير الجودة لدينا. يمكن العثور على معلومات أكثر تفصيلًا حول كل حقل ومتطلباته أدناه.

الشدة

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

لن يتم عرض حقل الشدة لأنواع الأخطاء الأخرى.

العنوان

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

عند كتابة عنوان الخطأ، صف ما يحدث بدلًا من ما لا يحدث. يجب ألا ينص عنوانك أبدًا على أن شيئًا ما لا يعمل، وإلا فلن يعرف القارئ ما يحدث فعليًا.

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

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

أمثلة على عناوين الأخطاء:

خطأ: خطأ معروض في صفحة السلة

صحيح: زر "إتمام الشراء" من صفحة السلة يوجه المستخدمين إلى صفحة "خطأ 500"

خطأ: المستخدم لا يمكنه إضافة منتج إلى السلة

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


الرابط (URL)

قم بزيارة الصفحة التي يظهر فيها الخطأ ونسخ ولصق الرابط من حقل URL في متصفحك إلى حقل URL في نموذج تقرير الأخطاء.

يجب أن يكون الرابط صالحًا.

خطوات إعادة الإنتاج

يجب أن تكون الأخطاء قابلة لإعادة الإنتاج وتحتاج إلى دليل خطوة بخطوة مفصل حول كيفية إعادة إنتاجها. يجب أن تصف كل خطوة إجراءً منفصلاً.

ملاحظة: لا تحتاج إلى ترقيم خطواتك حيث يتم ذلك تلقائيًا بواسطة نظامنا.

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

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

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

أمثلة على خطوات جيدة:

  1. أدخل أي استعلام بحث في شريط البحث أعلى اليمين (مثل "سان فرانسيسكو")

  2. اضغط على زر "بحث الآن"

  3. مرر لأسفل وانقر على "فرز حسب"

  4. اختر الخيار "الفرز حسب السعر: من الأعلى إلى الأدنى"

أمثلة على خطوات خاطئة:

  1. ملاحظة

  2. البحث > الفرز > من الأعلى إلى الأدنى

  3. ملاحظة

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

الناتج الفعلي

الناتج الفعلي هو أحد أهم الحقول في تقرير الخطأ لأنه هنا تشرح المشكلة وكل التفاصيل اللازمة لفهم الخطأ.

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

ملاحظات مهمة: يجب ألا يكون الناتج الفعلي والمتوقع مجرد العكس لبعضهما البعض. تختلف التوقعات حول ما كان يجب أن يحدث وما حدث فعليًا اختلافًا كبيرًا.

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

أمثلة على الناتج الفعلي:

خطأ: ظهور خطأ في صفحة السلة بعد الضغط على زر إتمام الشراء

صحيح: يظهر للمستخدم "خطأ 500 - خطأ داخلي في الخادم - عذرًا، حدث خطأ ما" بعد محاولته الانتقال إلى صفحة إتمام الشراء

خطأ: لا يمكن للمستخدم إضافة منتج إلى السلة، يظهر خطأ

صحيح: تظهر رسالة خطأ "خطأ غير متوقع" في أعلى يمين صفحة المنتج، ولا يتم إضافة المنتج إلى السلة


الناتج المتوقع

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

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

أمثلة على الناتج المتوقع:

خطأ: يمكن للمستخدم الانتقال إلى إتمام الشراء

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

خطأ: يجب إضافة المنتج إلى السلة

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

المرفقات

لتعرف نوع المرفق الذي يجب إرفاقه لتقريرك وما هي القواعد المطبقة، يرجى زيارة المقال التالي: متطلبات مرفقات تقرير الأخطاء.

البيئة المستخدمة

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

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

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

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

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

تحسين تقريرك

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

تذكر أنه لا يُسمح بعلامات النائب، لذا لا تقدم تقارير ناقصة لتحريرها لاحقًا.

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

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

هل أجاب هذا عن سؤالك؟