كيفية كتابة تقرير الأخطاء مع الأمثلة

ما هو تقرير الأخطاء؟ لماذا تحتاج إلى تقرير خطأ جيد؟

يعد تقرير الأخطاء مستندًا مهمًا في STLC ويقدم مزايا متنوعة لفريق الاختبار. فهو يتتبع جميع العيوب والأخطاء المتعددة والأخطاء والتناقضات الأخرى التي تم العثور عليها أثناء اختبار البرامج ويبلغ عنها.

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

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

لماذا يجب أن تهتم بتفسيرات الأخطاء الجيدة؟

تفسيرات جيدة للأخطاء

فيما يلي النقطة التي يجب عليك مراعاتها عند كتابة تقرير جيد ومفصل عن أخطاء البرامج:

  • إنه بمثابة دليل للمساعدة في تجنب نفس الخطأ في الإصدارات المستقبلية.
  • توفير الوقت للاتصال (e-mailق، المكالمات).
  • عمل أقل للمطورين (سيفعلون ما تريده بالضبط).
  • سيكون لديك اختناقات أقل في المشروع؛ سيتم إصلاح الأخطاء بطريقة أسرع وأكثر كفاءة.

كيفية كتابة تقرير الأخطاء (قالب تقرير الأخطاء)

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

ومع ذلك، فولوwing الحقول المشتركة مطلوبة دائمًا عندما تريد كتابة تقرير خطأ:

  • معرف الخطأ/العنوان.
  • الجدية والأولوية.
  • الوصف
  • البيئة
  • خطوات التكاثر.
  • نتيجة متوقعة.
  • نتيجة فعلية.
  • المرفقات (لقطات الشاشة ومقاطع الفيديو والنص)

دعونا نلقي نظرة على كل مكونات معالجة الأخطاء هذه واحدة تلو الأخرى:

1) معرف العنوان/الخطأ:

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

أمثلة:

❌ سيء: "لا أستطيع رؤية المنتج عندما أعود إليه مرة أخرى، فهو لا يظهر."

  • مشاكل
  • العدواني
  • كثير الكلام

ويطالب بتنفيذ الحل.

✅ جيد: "عربة التسوق - العناصر الجديدة المضافة إلى سلة التسوق والتي لا تظهر".

  • يحدد هذا النوع من العناوين المشكلة على الفور (عربة التسوق)
  • وهو يركز على المشكلة التقنية الفعلية.

2) خطورة الخطأ:

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

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

3) أولوية الخطأ:

فولوwing هو التدرج العام لتحديد أولوية الخطأ:

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

4) البيئة:

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

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

5) ملخص:

ومع ذلك، فإن إضافة العنوان فقط في تقرير الأخطاء لا يخدم الغرض. لذا، إذا لم يكن عنوانك كافيًا، فيمكنك إضافة ملخص تقرير قصير.

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

أمثلة:

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

6) خطوات التكاثر:

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

كن محددًا بشأن الخطوات التي يجب اتباعها:

فيما يلي مثال على الإجراء المكتوب جيدًا:

الخطوات التالية:

  1. حدد المنتج X1.
  2. انقر فوق إضافة إلى سلة التسوق.
  3. انقر فوق "إزالة" لإزالة المنتج من سلة التسوق.

7) النتيجة المتوقعة:

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

فمثلا:

يجب تمييز الحقول المطلوبة باللون الأحمر بعد النقر على زر "إرسال".

8) النتيجة الفعلية:

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

فمثلا:

يتم تمييز الحقول المطلوبة باللون الأخضر بعد النقر على زر "إرسال".

9) المرفقات (لقطات الشاشة ومقاطع الفيديو):

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

فمثلا:

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

10) النسخة المتأثرة:

إنه إصدار البرنامج المتأثر الذي تم الإبلاغ عن الخطأ فيه.

11) إصلاح الإصدار:

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

12) النسخة المستهدفة:

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

13) تاريخ الإغلاق:

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

14) الحالة:

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

نصائح لكتابة تقرير الأخطاء

فيما يلي بعض النصائح المهمة التي يجب أن تتذكرها أثناء كتابة تقرير فعال عن الأخطاء:

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

أدوات الإبلاغ عن الأخطاء

يتم الآن تنفيذ عملية الإبلاغ عن الأخطاء، التي يتم إجراؤها يدويًا، باستخدام أدوات الإبلاغ عن الأخطاء المتنوعة المتوفرة في السوق.

  • جيرة
  • متعقب الأخطاء من زوهو
  • بجزيلا

يمكنك التحقق من مراجعتنا التفصيلية لـ أفضل أداة للإبلاغ عن الأخطاء.

المشكلة الشائعة والحل أثناء كتابة تقرير الأخطاء:

فيما يلي بعض المشكلات الشائعة وحلولها أثناء كتابة تقرير الأخطاء:

مثال لتقرير الأخطاء المشكلة
عند ضرب 2 في 3 يكون الجواب إيجابيا. قم بالإبلاغ عن النمط، وليس مثالا.
سيتم ترتيب القائمة أبجديًا عند إضافة عنصر جديد لتجنب ذلك. لا تصف فقط ما هو الخطأ
فمثلا:
لكي تكون، سوف تحتاج إلى فتح المتصفح الخاص بك واكتب عنوان URL للموقع. ستجد الحقل الأول، "اسم المستخدم"، به خطأ إملائي.
توجه دائمًا إلى صلب الموضوع (لا تحكي القصة أبدًا!).
اسم العميل في التقرير به خطأ إملائي. الأولوية: عالية، درجة الخطورة: عالية لا تخلط أبدًا بين الأولوية والشدة.
معادلة حساب الضريبة غير صحيحة !!؟؟ لا يستخدم الأحرف الكبيرة، والأحرف الحمراء، والدوائر الحمراء، '!'،
لا أعتقد أن تصميم الصفحة الرئيسية Ul جيد. لا تستخدم حكمك.
مثال للوصف غير الواضح: بخصوص مناقشتنا اليوم، يرجى القيام بالإجراء المطلوب لهذه الصفحة. اجعل وصفك مفهوما للجميع.
يجب أن تكون خلفية الصفحة باللون الأزرق أو البرتقالي أو الأخضر، أو يمكنك جعلها باللون الأسود أو الأبيض.

هذا ليس جيدًا لأنه من غير الواضح ما هو المطلوب من فريق تطوير وتصميم الويب

تصغير الخيارات
في بعض الأحيان لا تعمل صيغة حساب الضريبة كما هو متوقع. القاعدة الذهبية: لا تستخدم كلمة "أحيانًا".

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

فيما يلي مثال صغير لتقرير الخطأ:

[حسابي] يتم عرض التسطير عند تمرير الماوس على زر التحديث.

الوصف: نحن بحاجة إلى إزالة التسطير عند تمرير الماوس على زر التحديث في قسم حسابي.

الرابط: http://test.com/mv-account/

المتصفح/نظام التشغيل: كروم 25. أو إس إكس يوسمايت 10.10.2

خطوات التكاثر:

1. انتقل إلى www.test.com

2. قم بتسجيل الدخول عبر بيانات اعتماد تسجيل الدخول

3. انتقل إلى حسابي

4. مرر الماوس على زر التحديث

نتيجة فعلية: هناك تسطير.

نتيجة متوقعة: لا تسطير.

بيانات تسجيل الدخول: test@test.com / mysecretpass12

يجب تجنب الأخطاء في كتابة تقرير الأخطاء

فيما يلي بعض الأخطاء المهمة التي يجب عليك تجنبها أثناء كتابة تقرير الأخطاء:

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