كيفية التخلص من إرتباط البرنامج بالمطور: التوثيق

السلام عليكم ورحمة الله

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

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

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

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

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

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

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

بالنسبة للمكتبات البرمجية فيمكن أن يكون خير توثيق لها هو عمل أمثلة كثيرة عن إستخدامها وبيان كافة ميزاتها.

 

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

One thought on “كيفية التخلص من إرتباط البرنامج بالمطور: التوثيق

  1. أول ما نقوم بتوثسقه هو الكود المصدر، مجرد ان انشيء المجلدات التابعة للمشروع اوقم بإضافتها إلى مستودعات SCM مثل GIT أو SubVersion (SVN) أو غيرها
    كل عملية commit اقوم بها اشرح لماذا تمت هذه التعديلات، ليتم الرجوع إليها في المستقبل.
    بالنسبة للمشاريع المفتوحة إذا لم موجودة على مستودعات خارجية لا يتعتبر مفتوحا بالنسبة لي، و لا أقوم باستخدامه، لانه غير موثق.

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

    بالله عليكم هل فهمتم شيئا؟

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

أضف تعليقاً

إملأ الحقول أدناه بالمعلومات المناسبة أو إضغط على إحدى الأيقونات لتسجيل الدخول:

WordPress.com Logo

أنت تعلق بإستخدام حساب WordPress.com. تسجيل خروج   / تغيير )

صورة تويتر

أنت تعلق بإستخدام حساب Twitter. تسجيل خروج   / تغيير )

Facebook photo

أنت تعلق بإستخدام حساب Facebook. تسجيل خروج   / تغيير )

Google+ photo

أنت تعلق بإستخدام حساب Google+. تسجيل خروج   / تغيير )

Connecting to %s