25 lines
1.8 KiB
Markdown
25 lines
1.8 KiB
Markdown
---
|
|
title: Code documentation
|
|
localeTitle: توثيق البرمجيات
|
|
---
|
|
## توثيق البرمجيات
|
|
|
|
توثيق الكود او توثيق البرمجيات هي عملية كتابة نصوص يتم إرفاقها مع الكود أو البرنامج. تلك النصوص هي كتابات نصية توضيحية تشرح آلية عمل البرنامج أو الكود، وكيفية استخدامه، والتعديل فيه اذا كان ذلك متاحاً، او كان منتج برمجى مفتوح المصدر.
|
|
|
|
تلك العملية هي إحدى المراحل الأساسية من مراحل هندسية البرمجيات، وذلك لأهميتها التي تتيح عملية فهم البرنامج أو الكود، وكيفية التعامل معه، حتى يكون على قدر كافى من الوضوح.
|
|
التوثيق البرمجى له نوعان رئيسيان:
|
|
|
|
• توثيق المنتج: وهى عملية توثيق لآلية عمل المنتج البرمجى، وعملية تصنيعه، وتوضيح كل طرق التعامل معه واستخدامه. وتنقسم تلك العملية الى نوعان:
|
|
توثيق النظام
|
|
توثيق الستخدم
|
|
|
|
• التوثيق العملى: وهى عملية توثيق كل الخطوات الإدارية والتخطيطية اللازمة التي تم تطوير المنتج البرمجى بناءً عليها.
|
|
|
|
|
|
|
|
|
|
#### معلومات اكثر:
|
|
|
|
1- https://ar.wikipedia.org/wiki/%D8%AA%D9%88%D8%AB%D9%8A%D9%82_%D8%A7%D9%84%D8%A8%D8%B1%D9%85%D8%AC%D9%8A%D8%A7%D8%AA
|
|
2- https://www.altexsoft.com/blog/business/software-documentation-types-and-best-practices/
|