هو شرح واجهة البرنامج للمستخدم أو شرح تصميمه(هيكلته الداخلية) للمطور
ما هو توثيق البرامج ؟
التوثيق انواع , هناك التوثيق التقنى للبرمجيات
و ابسط صورة هى محاولة كتابة التعليقات على كل اجزاء الكود و لها لغات تكتب بها فى حالة ان برنامجك كبير اما فى حالة ان البرنامج صغير او متوسط الحجم يمكن الاعتماد على لغة عامية او فصحى بشرط ان تكون سهلة و بسيطة على قارىء التعليق و توضح له اهمية هذة الدالة و كيفية استخدامها
النوع الثانى التوثيق الهندسى و غالبا ما يكون فى البرمجيات الضخمة و التى تعتمد بشكل اساسى على توثيق هيكلة البرنامج و معايير الاستخدام و معايير البرمجة و فى بعض الشركات يتم توثيق رخص البرامج المستخدمة و اشياء اخرى هامة
و انواع اخرى كثيرة يمكنك البحث عنها فى جوجل
و للتوثيق ادوات تساعدك فى جعلة اكثر فاعلية مثال على ذلك برنامج Doxygen و برنامج visual studio نفسة بة ادوات رائعة للتوثيق البرمجى و NDoc
التعليقات