ويكيبيديا

توثيق البرمجيات: الفرق بين النسختين

تصفح التاريخ تفاعلياً
[مراجعة غير مفحوصة][مراجعة غير مفحوصة]
→ التعديل السابقالتعديل اللاحق ←
تم حذف المحتوى تمت إضافة المحتوى
مرئينص الويكي
سطر 57:
 
=== التوثيق التقني ===
التوثيق التقني هو ما يقصده [[المبرمجون|مبرمج]] عندما يستخدمون التعبير [[توثيق البرمجيات]]. عندما يتم إنشاء [[برمجية]] فإن [[الشيفرة البرمجية|Code]] لا تكفي لوحدها. يجب أن تتوفر أيضاً بعض النصوص التي تصف الجوانب المختلفة للعمليات المطلوب من البرمجية تنفيذها. من الأهمية بمكان أن تكون وثائق الشيفرة البرمجية شاملة، لكن يجب في الوقت ذاته أن لا تكون طويلة بحيث يصعب تعديلها وحفظها. تستخدم برامج [[API Writer]] لكتابة العديد من الوثائق الخاصة بالبرمجيات كتعليمات الاستخدام. قد تستخدم الوثائق التقنية من قبل المبرمجين أو فاحصي البرامج والمستخدم النهائي للبرمجية. في الوقت الراهن، نرى العديد من التطبيقات المتقدمة المستخدمة في شتى المجالات كالطاقة والنقل والشبكات والفضاء والأمن والحماية والأتمتة الصناعية ومجالات أخرى عديدة. أصبح التوثيق التقني هاماً في هذه المجالات، نظراً لتغيير المعلومات الأساسية والمتقدمة بسرعة خلال فترات زمنية قليلة بما في ذلك التغيرات التي تجرى على معمارية البرامج. لذا، اكتسب التوثيق التقني أهمية عظيمة مؤخراً خصوصاً في عالم البرمجيات.
This is what most [[programmer]]s mean when using the term ''software documentation''. When creating [[software]], [[source code|code]] alone is insufficient. There must be some text along with it to describe various aspects of its intended operation. It is important for the code documents to be thorough, but not so verbose that it becomes difficult to maintain them. Several How-to and overview documentation are found specific to the software application or software product being documented by [[API Writer]]s. This documentation may be used by developers, testers and also the end customers or clients using this software application. Today, we see lot of high end applications in the field of power, energy, transportation, networks, aerospace, safety, security, industry automation and a variety of other domains. Technical documentation has become important within such organizations as the basic and advanced level of information may change over a period of time with architecture changes. Hence, technical documentation has gained lot of importance in recent times, especially in the software field.
غالباً ما تستخدم أدوات إنشاء الوثائق (كـ [[Doxygen]]، [[NDoc]]، [[javadoc]]، [[EiffelStudio]]) لإنشاء ملفات الشيفرة البرمجية أوتوماتيكياً، أي أنها تستخلص الملاحظات وتبنى [[عقود البرمجيات|التصميم بالعقود]] من الشيفرة المصدرية وتُنشئ كتيبات مرجعية ذات صيغ ملفات نصية أو ملفات [[HTML]]. غالباً ما تنظّم ملفات الشيفرة البرمجية بأسلوب "الدليل المرجعي"، ما يتيح للمبرمج سرعة البحث عن class أو وظيفة معينة في البرمجية.
 
Often, [[Documentation generator|tools]] such as [[Doxygen]], [[NDoc]], [[javadoc]], [[EiffelStudio]], [[Sandcastle (software)|Sandcastle]], [[ROBODoc]], [[Plain Old Documentation|POD]], [[TwinText]], or [[Universal Report]] can be used to auto-generate the code documents—that is, they extract the comments and [[Design by Contract|software contracts]], where available, from the source code and create reference manuals in such forms as text or [[HTML]] files. Code documents are often organized into a ''reference guide'' style, allowing a programmer to quickly look up an arbitrary function or class.
 
The idea of auto-generating documentation is attractive to programmers for various reasons. For example, because it is extracted from the source code itself (for example, through [[comment (computer programming)|comment]]s), the programmer can write it while referring to the code, and use the same tools used to create the source code to make the documentation. This makes it much easier to keep the documentation up-to-date.
مجلوبة من «https://ar.wikipedia.org/wiki/توثيق_البرمجيات»