توثيق البرمجيات Software Documentation

ما هو التوثيق في هندسة البرمجيات؟

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

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

أنواع توثيق البرمجيات:

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

وثائق المنتج:

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

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

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

توثيق العملية:

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

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

توثيق البرمجيات في نهجي التطوير الشلال والرشيق Waterfall and Agile Methodologies:

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

نهج الشلال Waterfall:

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

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

نهج الرشيق Agile:

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