كيف تكتب وثائق ضمان الجودة التي ستعمل بالفعل

منتج البرنامج مثل الطائرة: يجب أن يخضع لفحص فني قبل الإطلاق.

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

هناك العديد من أنواع اختبار البرامج - آليًا ويدويًا ، استكشافيًا ووظيفيًا ، التوافق ، UI / UX ، الانحدار ، الوحدة ، API ، واختبار الأداء. حظا سعيدا لف رأسك حولهم جميعا!

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

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

ضع خطة اختبار وتقرير عن تقدم الاختبار

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

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

ستساعدك خطة الاختبار على فهم ما يلي:

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

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

خطة الاختبار والتقرير

إنشاء حالات الاختبار

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

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

  1. المعرف هو رقم فريد مخصص لحالة الاختبار الخاصة بك.
  2. في قسم حالة الاختبار ، تشير إلى المتطلبات التي ستختبرها وتقدم رابطًا لها في مستند المواصفات.
  3. في قسم " خطوات الاختبار" ، تقوم بإدراج جميع الإجراءات اللازمة لإكمال حالة الاختبار.
  4. في قسم " النتيجة المتوقعة" ، تقوم بتلخيص نتيجة اختبار معين إذا كان ناجحًا.
  5. في قسم الحالة ، تشير إلى ما إذا كانت خطوة معينة قد نجحت أو فشلت في الاختبار.
  6. في قسم " النتيجة الفعلية" ، تشرح نتيجة الاختبار الفاشل.
  7. و تعليقات القسم ليس إلزاميا، ولكن يمكنك إضافته إلى ترك بعض الملاحظات الإضافية.
حالة اختبار

اكتب تقرير عيب

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

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

تقرير الخلل

يتألف تقرير العيب من الأقسام التالية: المعرف والملخص والوصف وخطوات إعادة الإنتاج وقابلية إعادة الإنتاج والخطورة والأولوية والبيئة والمرفقات.

  1. يتم تعيين رقم فريد لكل مشكلة برمجية معينة - المعرف . يعمل على تحسين التنقل عبر مستندات ضمان الجودة ويسهل الاتصال بين المطورين والمختبرين ومدراء المشاريع.
  2. في قسم الملخص ، تقدم إجابة موجزة لثلاثة أسئلة بسيطة: ماذا حدث وأين وتحت أي ظروف.
  3. في قسم الوصف ، تصف الخطأ بالتفصيل. يجب أن تخبرنا عن النتائج الفعلية والمتوقعة. من المفيد توفير رابط لمتطلبات البرامج الخاصة بك.
  4. ثم تكتب عن خطوات إعادة إنتاج (STR) . يوضح هذا للمطورين بالضبط كيفية إعادة إظهار المشكلة. لا تفوت خطوة أو قد يعود التقرير الخاص بك إليك.
  5. في قسم إمكانية تكرار النتائج ، يمكنك توضيح ما إذا كان الخطأ يظهر في كل مرة تتبع فيها تقرير المشتبه به. يجب عليك استخدام الأرقام لإظهار الفرص التقريبية ، على سبيل المثال 7 مرات من 10.
  6. في قسم الخطورة ، تشرح مقدار الضرر الذي قد يسببه الخطأ للمشروع. بمعنى آخر ، يُظهر الدرجة التكنولوجية لتأثير الخلل على النظام بأكمله. حتى مشكلة صغيرة قد تؤثر بشدة على التطبيق بأكمله
  7. توضح الأولوية مدى أهمية تقرير عيب معين. يمكن الإشارة إلى الأولوية بمساعدة الأحرف - "A" للأكثر إلحاحًا و "Z" للأقل إلحاحًا ، والأرقام - "1" للأكثر إلحاحًا و "9" للأقل إلحاحًا ، أو ببساطة كلمات مثل "مرتفع" "أو" متوسطة "أو" منخفضة ".
  8. في قسم البيئة ، يجب تحديد أنظمة التشغيل أو إصدارات المستعرض التي تأثرت.
  9. أخيرًا ، تتضمن المرفقات قائمة مقاطع الفيديو أو لقطات الشاشة أو ملفات سجلات وحدة التحكم المضافة إلى تقرير العيب.

ضع في اعتبارك هذه النصائح المفيدة لكتابة تقرير العيب

  1. اكتب ملخصًا كافيًا وكافًا. لا يهم إذا كانت طويلة أو قصيرة. ما يهم هو أن يكون واضحا.
  2. ألق نظرة على الملخص والوصف. هل يبدون متشابهين إلى حد كبير؟ يجب أن تكون قد نسيت تحديد النتائج المتوقعة والفعلية في الوصف وإضافة ارتباط إلى المتطلبات.
  3. التقط المشكلة بمساعدة لقطة شاشة. قد يوفر عليك وعلى فريق التطوير الكثير من الوقت. في بعض الأحيان ، يكفي إلقاء نظرة واحدة على الصورة لفهم الموقف.
  4. قبل الإبلاغ عن المشكلة ، حاول إعادة إنتاجها 3 مرات على الأقل للتأكد من وجودها.
  5. أبلغ عن المشكلة في أسرع وقت ممكن وأبلغ مدير المشروع أو مالك المنتج إذا كانت المشكلة كبيرة.
  6. تحقق من وجود أخطاء نحوية في وثائق ضمان الجودة الخاصة بك حتى لا يتم إسقاطك من قبل شرطة القواعد.
  7. مهما بدا الأمر كوميديًا ، تأكد من أن المشكلة ليست ميزة - راجع الوثائق مرة أخرى!
  8. لا تفوت أي معلومات مهمة في "خطوات إعادة الإنتاج".

إرسال تقرير عيب

تمر تقارير العيوب عبر دورة حياة - من اللحظة التي تبلغ فيها عن مشكلة إلى لحظة إغلاقها.

دورة حياة تقرير العيب

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

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

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

للختام

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

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

هل تحتاج إلى تحسين جودة برامجك؟

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

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

ملاحظة

يمكن العثور على المقالة الأصلية المنشورة على مدونة KeenEthics هنا: كيف تكتب وثائق ضمان الجودة التي ستعمل؟