الطريقة الصحيحة لقراءة التوثيقات البرمجية

كيف أقرأ الوثائق عند البرمجة؟

كثير من المبتدئين في البرمجة يواجهون صعوبة في فهم و قراءة الوثائق ( Documentations ) البرمجية عند البحث عن مشكلة معينة ومحاولة الوصول لحلها.

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

ما هو التوثيق؟

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

1- إفهم الجزء الأول في الوثائق

أغلب الوثائق تحتوي في بدايتها على القسم هذا بمسميات مختلفة مثل ( Get Started، Quick Start,، Guides ) أو غيرها. هذا الجزء مهم جداً و يعتبر مدخل و بداية لفهم اللغة أو التقنية، و يحتوي عادة على أمثلة بسيطة و صغيرة لكيفية استخدامها.

البعض قد يُهمل هذا القسم و يذهب مباشرة للنقطة المطلوبة من غير فهم واضح للبداية.

نصيحتي لك: فهم الأساسيات الموضوعة هو الأولوية.

2- التركيز على النصائح المتنوعة

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

مثال

التسلسل الهرمي للملفات

تمثيل التسلسل الهرمي للملفات في الوثائق يوضح لك الطريقة الصحيحة التي بُني فيها تسلسل الملفات في مشروعك و ما هي الملفات الفرعية و الملفات الرئيسية في المشروع.

التجربة المباشرة

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

فمثلاً موقع jsonplaceholder يوفر لك API مع أمثلة يمكنك تجربتها بشكل مباشر فيه كما في الصورة التالية.

4- تحقق من إصدار التوثيق

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

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

5- تعلّم قراءة الكود البرمجي داخل الوثائق

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

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

6- إستخدم مصادر متعددة مع الوثائق

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

ختام

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