توثيق أكواد لغة بايثون باستخدام نمط غوغل للتوثيق

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

man filling in form on parer at table
Photo by Ryutaro Tsukata on Pexels.com
أكمل قراءة المقالة

توثيق البرمجيات: أنواعها وأفضل الطرق المتّبعة في منهجية أجايل الرشيقة

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

man filling in form on parer at table
Photo by Ryutaro Tsukata on Pexels.com
أكمل قراءة المقالة