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

ما هو توثيق البرنامج What is Software Documentation

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

أنواع توثيق البرمجيات Types of Software Documentation

• توثيق المتطلبات (Requirement Documentation): هو توثيق لطريقة عمل البرنامج، والبيئة المطلوبة لتشغيل البرنامج، وتكتب هذه التوثيقات في مرحلة تطوير البرنامج، وأيضا تكتب في مرحلة الاختبار في بعض الحالات، وتنفيذ هذا النوع من التوثيقات يؤكد على معايير الجودة والتوثيق.
• توثيق الهيكلية (Architectural Documentation): هو نوع خاص من أنواع التوثيق، والذي يهتم بتصميم البرنامج وهيكليته وطرق العمل الوظيفية والغير وظيفية، ويحتوي هذا التوثيق على بعض الأجزاء من الكود، ولكن الاهتمام الأكبر يتمحور حول أجزاء النظام الرئيسية والوحدات وترابطها مع بعضها، وطريقة مرور البيانات بين أجزاء النظام المختلفة.
• التوثيق التقني (Technical Documentation): هذا النوثيق يهتم بكل الأمور التقنية في البرنامج، مثل: واجهة برمجة التطبيقات (API)، الخوارزميات وهياكل البيانات (DSA)، ويهتم المطورون بها التوثيق أكثر من غيره.
• توثيق المستخدم النهائي (End-User Documentation): ويعد هذا التوثيق للمستخدم النهائي للبرنامج، لفهم كيفية التعامل مع البرنامج، واستخدام الوظائف والخدمات المتوفرة، ويوجد العديد من موارد الدعم المتاحة للمستخدم في هذا التوثيق.

الهدف من التوثيق Purpose of Documentation

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

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

مبادئ توثيق البرمجيات Principles of Software Documentation

ضع نفسك مكان القارئ

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

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

تجنب التكرار

على كاتب التوثيق استخدام معلومات مهمة، والحرص على عدم تكرار هذه المعلومات داخل التوثيق، ويمكن تمثيل هذا المبدأ بنفس مبدأ تجنب التكرار (Avoid Redundancy) في قواعد البيانات، حيث تخزن قاعدة البيانات في البرامج كل معلومة كوحدة واحدة، ثم تعرض هذه المعلومات بأشكال مختلفة، لذا تكرار المعلومات في قاعدة البيانات أمر غير مقبول وقد يسبب المشاكل.

تجنب الغموض

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

اتباع منهجية محددة

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

تحديث التوثيق دائما

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

ما هي جودة البرمجيات What is Software Quality

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

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

عوامل جودة البرمجيات Factors of Software Quality

قابلية النقل Portability

يمكن القول أن البرنامج قابل للتنقل عندما يتكون البرنامج من عدة وحدات (Modules)، وهذه الوحدات يمكن تخزينها في بيئات وأجهزة مختلفة، ولكل وحدة المكتبات التي تعتمد عليها (Dependencies) والتي يمكن نقلها أيضا من بيئة إلى أخرى.

قابلية الاستخدام Usability

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

إعادة الاستخدام Reusability

البرنامج المميز يتكون من وحدات (modules) قابلة لإعادة الاستخدام، أي يمكن استخدامها في مشاريع أخرى، وتطوير منتجات مفيدة للسوق.

قابلية الصيانة Maintainability

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

الكفاءة Efficiency

كلما زادت كفاءة البرنامج، كلما قل استهلاكه لوقت وحدة المعالجة المركزية والذاكرة العشوائية (CPU and Memory)، ومساحته، ونطاق شبكته، واستخدامه للموارد الأخرى، وهذا من الأمور المهمة للعملاء لتقليل تكاليف تشغيل البرنامج.

نظام إدارة جودة البرمجيات Software Quality Management System

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

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

تطور نظام إدارة الجودة Evolution of Quality Management System

• الهدف الأساسي لرقابة الجودة (Quality Control) هو البحث عن الأجهزة المعيبة، وتساعد أيضا في الكشف عن الأسباب التي تؤدي إلى هذه العيوب.
• ضمان الجودة (Quality Assurance) يساعد المؤسسة في صنع برمجيات ذات جودة عالية، تندرج تحت معايير الجودة والتوثيق.
• إدارة الجودة الشاملة (Total Quality Management): تتحقق من جميع الإجراءات في المنتج من خلال مقاييس محددة.

معايير الجودة والتوثيق مهمة جدا لتطوير منتجات يمكن الاعتماد عليها، وتحقق جميع متطلبات العملاء والمستخدمين.