ما هو دليل المبرمج؟ الوثائق الفنية
G O S U D A R S T V E N N Y S T A N D A R T S O Y W A S S R
|
النظام الموحد لتوثيق البرامج |
غوست 19.504-79(ست سيف 2095-80) |
دليل المبرمج.
|
|
|
النظام المتحد لتوثيق البرامج. |
بقرار من لجنة الدولة للمعايير التابعة لمجلس وزراء اتحاد الجمهوريات الاشتراكية السوفياتية بتاريخ 12 يناير 1979 رقم 74، تم تحديد تاريخ التقديم
من 01.01. 1980
يحدد هذا المعيار متطلبات محتوى وتصميم وثيقة البرنامج "دليل المبرمج"، المحددة في GOST 19.101-77.
يتوافق المعيار تمامًا مع ST SEV 2095-80.
1. أحكام عامة
1.1. تم إنشاء هيكل وتصميم الوثيقة وفقًا لـ GOST 19.105-78.
يعد إعداد جزء المعلومات (الشروح والمحتويات) أمرًا إلزاميًا.
1.2. يجب أن يحتوي دليل المبرمج على الأقسام التالية:
- الغرض وشروط تطبيق البرامج؛
- خصائص البرنامج
- الوصول إلى البرنامج.
- بيانات الإدخال والإخراج؛
- رسائل.
اعتمادا على تفاصيل الوثائق، من الممكن الجمع بين الأقسام الفردية أو إدخال أقسام جديدة.
2.1. يجب أن يشير قسم "الغرض وشروط استخدام البرامج" إلى الغرض والوظائف التي يؤديها البرنامج، والشروط اللازمة لتنفيذ البرنامج (حجم ذاكرة الوصول العشوائي، ومتطلبات تكوين ومعلمات الأجهزة الطرفية، ومتطلبات البرامج، وما إلى ذلك) .
2.2. يجب أن يحتوي قسم "خصائص البرنامج" على وصف للخصائص والميزات الرئيسية للبرنامج (خصائص التوقيت، وضع التشغيل، وسائل مراقبة التنفيذ الصحيح والإصلاح الذاتي للبرنامج، وما إلى ذلك).
2.3. يجب أن يحتوي قسم "الوصول إلى البرنامج" على وصف لإجراءات استدعاء البرنامج (طرق نقل معلمات التحكم والبيانات، وما إلى ذلك).
2.4. يجب أن يصف قسم "بيانات الإدخال والإخراج" تنظيم معلومات الإدخال والإخراج المستخدمة، وإذا لزم الأمر، ترميزها.
2.5. يجب أن يشير قسم "الرسائل" إلى نصوص الرسائل الصادرة للمبرمج أو المشغل أثناء تنفيذ البرنامج ووصف محتواها والإجراءات التي يجب اتخاذها رداً على هذه الرسائل.
2.6. قد يحتوي ملحق دليل المبرمج على مواد إضافية (أمثلة، رسوم توضيحية، جداول، رسوم بيانية، إلخ).
* إعادة الإصدار (نوفمبر 1987) مع التغيير رقم 1، تمت الموافقة عليه في سبتمبر 1981 (IUS 11-81)
أهداف و غايات
يتم تطوير دليل المبرمج في ثلاث حالات:
- منتج البرنامج، بحكم غرضه الرئيسي، هو بيئة تطوير أو مكتبة (مثل دلفي أو كيو تي)؛
- يعمل منتج معقد أو برمجي كمنصة لتطوير برامج أو أنظمة من نوع معين (مثل 1C أو Axapta)؛
- يتم توزيع البرنامج مع الكود المصدري أو يتم تعديله باستمرار بواسطة المطورين أنفسهم.
يمكنك بالتأكيد أن تتخيل مواقف أخرى (على سبيل المثال، منتج البرنامج هو نظام تشغيل)، لكنها أقل شيوعًا في الحياة.
تتمثل المهمة الواضحة لإدارة المبرمج في تزويد المطور بالمعلومات التي ستكون كافية له لإنشاء برامجه أو أنظمته الخاصة بناءً على منتجنا البرمجي. الدافع الآخر لإنشاء مثل هذه الوثيقة هو حاجة المطورين إلى تسجيل حالة المنتج من وقت لآخر، حتى لا يتم الخلط بينهم وعدم إنتاج حاملي "المعرفة المقدسة" في الفريق.
يجب أن يوضح دليل المبرمج ما يلي:
- كيف يعمل "العالم" الذي ينغمس فيه المطور. ما الأشياء التي يتعامل معها المبرمج ومكان تواجدها ومدة وجودها وكيفية تفاعلها مع بعضها البعض. أي منهم يخلق نفسه، والتي يتم توفيرها له في البداية من خلال البيئة والإطار والمكتبة.
- ما هي أدوات التطوير الأخرى (إلى جانب منتجنا البرمجي) اللازمة لإنشاء تطبيق أو نظام؟ على سبيل المثال، إذا كان منتجنا البرمجي عبارة عن مكتبة، فسيحتاج المبرمج إلى مترجم (ربما محدد تمامًا)، ونوع من بيئة التطوير وأدوات أخرى.
- في أي بيئة يعمل التطبيق أو النظام؟ ماذا سيكون الحد الأدنى لمتطلبات النظام؟ هل ستحتاج إلى أي برامج إضافية لتشغيله: أطر العمل، وأوقات التشغيل، والمترجمين الفوريين.
- ما الذي يشكل الحد الأدنى من التطبيقات القابلة للتشغيل أو الحد الأدنى من نظام التشغيل. ما هي الكائنات التي يجب إنشاؤها وبأي تسلسل، وكيفية ربطها ببعضها البعض حتى يعرض التطبيق على الأقل "Hello World". صحيح أن هناك تطبيقات لا تعرض النص على الإطلاق، ولكنها تتحكم في الفرن العالي أو حركة المرور على الشبكات، ولكن لا يزال لديها بالضرورة نوع من الحد الأدنى من الإخراج.
- كيفية (خطوة بخطوة) تجميع تطبيق عمل أو نشر نظام عمل.
هذه أسئلة أساسية، بدون إجابات لن يتمكن المبرمج من العمل بشكل طبيعي. إذا لم يتم إبلاغه به صراحة، فسوف يضطر إلى إجراء بحث. ولكن هناك العديد من الأساليب الإضافية: أساليب وتقنيات تصحيح الأخطاء، وأسلوب البرمجة، وما إلى ذلك.
بالإضافة إلى النظرية، يجب أن يحتوي دليل المبرمج على أوصاف كاملة لجميع العناصر المتوفرة في منتج البرنامج. إذا كانت هذه وظائف، فيجب تقديم ملخصاتها، وإذا كانت فئات، فيجب تقديم وصف لواجهاتها، وما إلى ذلك.
إذا كان منتج البرنامج يتضمن استخدام لغة برمجة أصلية ومجهزًا بمترجم أو مترجم خاص به، فيجب تضمين وصف له في دليل المبرمج. ومع ذلك، إذا تبين أنها ضخمة جدًا، فسيتم وضعها في مستند منفصل يسمى: وصف اللغة (البرمجة).
منهجية وأسلوب العرض
أهم المتطلبات المنهجية للجزء النظري من دليل المبرمج هي المنطق واتساق العرض. وعلى وجه الخصوص، يجب مراعاة القواعد التالية في النص:
- عند تقديم مفهوم جديد، فإننا نعتمد فقط على تلك المفاهيم التي تم تقديمها مسبقًا بشكل صريح أو التي تعتبر مألوفة بشكل واضح للقارئ. تماما كما هو الحال في كتاب الرياضيات.
- لا ينبغي للقارئ أن يشعر أبدًا بأن المؤلف يخلق كيانات دون داع. يجب تبرير إدخال كل مفهوم بطريقة ما.
الشرط الرئيسي عند وصف الكائنات الفردية هو اكتمال وصف كل منها. على عكس دليل المستخدم، عند تجميع ما يمكنك، من حيث المبدأ، الاعتماد على براعة القارئ الذي سينظر إلى الواجهة ويكتشفها بنفسه، يصف دليل المبرمج أشياء غير واضحة للغاية. وعلى الرغم من أنه من المتوقع أن يكون المبرمج أكثر بصيرة من المستخدم، إلا أنه سيتعين عليه تعويض نقص المعلومات عن طريق تحليل النص المصدر، وإذا كان متاحًا، فمن خلال اختبار "الصندوق الأسود" ومصحح الأخطاء. هذه عملية أطول بكثير من التجول عبر القوائم ومربعات الحوار.
عند وصف الأشياء، ينبغي إيلاء اهتمام خاص للجوانب التالية:
- ما يجب أن يسبق بالضرورة إنشاء واستخدام الكائن.
- ما هي الآثار الجانبية للوصول إلى الكائن.
- مميزات تفسير الكائن للبيانات المرسلة إليه.
- حيث يوجد الكائن "فعليًا" (في أي ملف وفي أي مكتبة).
يُنصح بتقديم أمثلة للاستخدام لكل كائن، وأجزاء صغيرة من التعليمات البرمجية توضح ما يلي:
- إنشاء كائن (إذا كان من الضروري إنشاؤه قبل استخدامه)؛
- تمرير بيانات الإدخال إلى الكائن؛
- الحصول على بيانات المخرجات وتفسيرها.
يمكن وضع أوصاف الكائنات في مجلد أو مستند منفصل يسمى "دليل المبرمج". الفكرة الجيدة هي جعله نصًا تشعبيًا.
بين الجزء النظري والكتاب المرجعي الخاص بالأشياء، من المفيد وضع قسم صغير يتم فيه النظر في مثال صغير ولكنه كامل من وجهة نظر النظام الأساسي المستخدم. يجب أن يكون المثال بحيث يمكن للقارئ إعادة إنتاج هذا التطبيق وتصحيح أخطائه وتشغيله بشكل مستقل. من الواضح، للقيام بذلك، كل هذا يجب أن يتم أولاً بواسطة أحد مؤلفي دليل المبرمج.
هيكل نموذجي
هيكل دليل المبرمج، المثبت في GOST 19.504-79، هو كما يلي:
- الغرض وشروط استخدام البرنامج.
- خصائص البرنامج.
- الوصول إلى البرنامج.
- بيانات الإدخال والإخراج.
- رسائل.
مثل هذا الهيكل لا يعطي الانطباع بأنه مفيد في الظروف الحديثة. بدلاً من ذلك، يمكن وصف كائن منفصل، مثل وظيفة أو فئة، باستخدام هذه الخطة. لن نقوم بإنشاء هيكل قياسي لدليل المبرمج لجميع المناسبات. على الأرجح، سوف يتبين أنها سطحية وقليلة الفائدة على حد سواء. بدلاً من ذلك، إليك هيكلين مثالين:
الخصائص
لا يمكن كتابة دليل المبرمج الكامل إلا بواسطة مؤلف لديه خبرته الخاصة في تطوير البرامج الاحترافية.
يمكن استكمال دليل المبرمج برسوم بيانية مختلفة، على سبيل المثال، رسوم بيانية لقاعدة البيانات، ورسوم بيانية للفئات، ورسوم بيانية لاستدعاء الوظائف (انظر المثال).
أمثلة
APK "نوستراداموس". دليل المبرمج
تم تصميم حزمة البرامج التحليلية "Nostradamus" لإنشاء أنظمة مصرفية تحليلية وإعداد التقارير. يحتوي على مجموعة من المكونات المتخصصة التي يقوم المطور من خلالها ببناء تطبيق في بيئة مرئية. إذا لزم الأمر، يمكن كتابة رمز البرنامج بلغة باسكال (وبالتالي، وصف لغة البرمجة غير مطلوب). تم تطوير حزمة البرامج بواسطة ProgramBank، والوثائق الفنية من قبل Philosoftبأمرها. بالإضافة إلى دليل المبرمج، تتضمن مجموعة الوثائق كتابًا مرجعيًا شاملاً عن جميع مكونات المجمع الصناعي الزراعي.
1. معلومات عامة 1.1. الاختصارات 1.2. الغرض 1.3. وظيفة 1.4. شروط الاستخدام 1.5. متطلبات مؤهلات المطور 2. حل التطبيق ومكوناته 2.1. عمارة المجمع الصناعي الزراعي "نوستراداموس". مفهوم الحل التطبيقي 2.2. متطلبات الحل التطبيق 2.2.1. المتطلبات الأساسية 2.2.2. متطلبات إدخال البيانات 2.2.3. متطلبات خوارزميات حساب البيانات 2.2.4. متطلبات التقارير ومجموعة كل منها 2.2.5. متطلبات التحكم في الوصول وأمن المعلومات 2.3. مكونات حل التطبيق 2.3.1. هيكل قاعدة البيانات 2.3.2. تحميل بيانات المصدر 2.3.3. تنظيم واجهة المستخدم 2.3.4. عمل المستخدم مع البيانات 2.3.5. معالجة البيانات وحسابها 2.3.6. عرض البيانات 2.3.7. أدوات للتحميل التلقائي ومعالجة البيانات. وكيل النظام 2.4. التفريق بين حقوق الوصول في حل التطبيق 2.4.1. أدوار المستخدم 2.4.2. ملفات تعريف المستخدمين 2.5. دورة حياة حل التطبيق 3. مثال على حل التطبيق 3.1. صياغة المشكلة. تحديد متطلبات حل التطبيق 3.2. تصميم حل التطبيق 3.2.1. تصميم هيكل الجدول وإجراءات تحميل البيانات 3.2.2. تصميم واجهة المستخدم 3.2.3. تصميم إجراءات الحساب والتقارير 3.3. تنفيذ حل التطبيق 3.3.1. التفويض في APK "نوستراداموس" 3.3.2. إنشاء فئة الحل 3.3.3. إنشاء الجداول 3.3.4. إنشاء إجراءات تحميل البيانات 3.3.5. إنشاء الدلائل والنماذج المرئية لهم 3.3.6. إنشاء إجراءات حسابية بلغة إجراءات قاعدة البيانات المخزنة 3.3.7. إنشاء التقارير 3.3.8. إنشاء مجموعات المستخدمين وإنشاء القائمة الرئيسية لهم 3.3.9. إنشاء إجراء لتحديث (تنزيل) البيانات تلقائيًا باستخدام وكيل النظام 3.4. نشر حل التطبيق 3.5. اختبار حل التطبيق 3.6. تعقيد المشكلة 3.7. الانتهاء من حل التطبيق 3.7.1. إنشاء تقرير تفاعلي 3.7.2. إنشاء تنزيل تفاعلي 3.7.3. المرحلة النهائية لإجراء تحسينات على حل التطبيق
تاجر نظام المنافذ الإلكترونية. بروتوكول خادم العميل
تم تصميم نظام “تاجر المنافذ الإلكترونية” لتلقي وإجراء الدفعات الفورية عند الدفع مقابل خدمات الاتصالات المتنقلة والوصول إلى الإنترنت وما إلى ذلك، وينتمي الخادم المركزي للنظام إلى مجموعة المنافذ الإلكترونية، ويمكن لأي شخص فتح نقطة قبول الدفع عن طريق تثبيته على برنامج العميل الخاص بجهاز الكمبيوتر (المتصل بالإنترنت). يتم تبادل البيانات بين الخادم المركزي وبرنامج العميل باستخدام بروتوكول خاص. البروتوكول مفتوح، مما يسمح لمختلف المؤسسات: البنوك، وسلاسل البيع بالتجزئة، وشبكات محطات الدفع، بإجراء الدفعات مباشرة من أنظمتها الخاصة. تم تطوير البروتوكول من قبل مجموعة المنافذ الإلكترونية، والوثائق الفنية من قبل Philosoftبأمرها.
مقدمة ط. نظام تاجر المنافذ الإلكترونية: بروتوكول خادم العميل. الغرض ونظرة عامة على القدرات ii. أهداف البروتوكول ثالثا. المزايا الرئيسية لاستخدام البروتوكول 1. تنفيذ البروتوكول (البوابة) 1.1. معلومات عامة 1.2. هيكل التطبيق 2. كيف تعمل البوابة 2.1. التسجيل وإعداد التقارير 2.1.1. التسجيل 2.1.2. الإبلاغ 2.2. تبادل البيانات مع الخادم 2.2.1. هيكل الحزمة 2.2.2. الدلائل 2.2.3. إجراء تبادل الحزم 2.3. دورة معالجة العمليات 2.3.1. طلب العملية 2.3.2. قائمة الانتظار 2.3.3. تحليل استجابة الخادم 2.3.4. المواقف غير القياسية 3. مواصفات البروتوكول 3.1. العناصر الهيكلية للحزمة 3.2. عنوان الطلب 3.3. رأس الاستجابة 3.4. تجديد الحساب 3.5. شراء رمز PIN 3.6. مقاطعة عملية معالجة المعاملات 3.7. خصائص المعاملات للعملية 3.8. طلب عمليات متعددة 3.9. كتيب 3.10. حالة التشغيل 3.10.1. أمثلة على الرسائل حول حالة العمليات 3.10.2. رموز الحالة للمعاملات المعلقة أو المكتملة 3.11. إشعارات النظام 4. ملحق تطبيقات المسرد 1. طلب XML DTD والتعليق طلب XML DTD التعليق الملحق 2. استجابة XML ملحق DTD 3. قواعد حساب حقول المجموع الملحق 4. أمثلة لطلبات الخادم واستجاباته
جامعة أوفا الحكومية لتقنية الطيران
قسم الرياضيات الحاسوبية وعلم التحكم الآلي
برنامج تطبيقي لتسجيل التطبيقات ومراقبة تنفيذها باستخدام مثال Integrated Transport Network LLC.
دليل المبرمج
حاشية. ملاحظة
يتوفر دليل مبرمج لتسجيل التطبيقات ومراقبة تنفيذها باستخدام مثال شركة Integrated Transport Network LLC.
يجب تطوير منتج برمجي لمؤسسة مصممة لأتمتة استراتيجيات تفاعل العملاء، على وجه الخصوص، لزيادة المبيعات وتحسين خدمة العملاء من خلال تخزين المعلومات حول العملاء وبياناتهم الشخصية. يجب أيضًا تنفيذ توزيع البريد الإلكتروني لمستخدمي هذا المنتج، بالإضافة إلى إحصائيات توضح عدد الطلبات التي قدمها المستخدم يوميًا وشهريًا.
يناقش دليل المبرمج الغرض والخصائص والشروط اللازمة لتنفيذ البرنامج
الغرض من البرنامج
سيتم استخدام منتج البرنامج في NetTrans (Integrated Transport Network LLC) في أقسام الدعم الفني والمشتركين والإنشاءات كنموذج تفاعل يعتقد أن مركز فلسفة العمل بأكملها هو العميل، والأنشطة الرئيسية هي تدابير لدعم المبيعات وخدمة العملاء. لا يمكن استخدام هذا البرنامج إلا من قبل المستخدمين المسجلين، ويتم التسجيل بدوره من قبل المسؤول فقط، وذلك عن طريق إضافة مستخدم جديد إلى قاعدة البيانات، ومن الممكن أيضًا الاحتفاظ بإحصائيات المشغل التي تشكل تطبيقات المشترك.
2. الشروط اللازمة لتنفيذ البرنامج
لتشغيل منتج البرنامج، يلزم تكوين الأجهزة والبرامج التالية:
Windows 7، Windows Server 2003 Service Pack 2، Windows Server 2008، Windows Server 2008 R2، Windows Vista، Windows Vista Service Pack 1، Windows XP Service Pack 2، Windows XP Service Pack 3؛
أنظمة 32 بت: جهاز كمبيوتر مزود بمعالج Intel أو معالج متوافق يعمل بسرعة 1 جيجا هرتز أو أسرع (يوصى بـ 2 جيجا هرتز أو أسرع، ويدعم معالج واحد فقط)؛
أنظمة 64 بت: معالج بسرعة 1.4 جيجا هرتز أو أسرع (يوصى بمعالج بسرعة 2 جيجا هرتز أو أسرع، ويدعم معالج واحد فقط)؛
1 غيغابايت من المساحة الحرة على القرص؛
التوفر نظم إدارة قواعد البيانات: MS SQL 2008;
3. خصائص البرنامج
3.1. وضع تشغيل البرنامج
الحوار. واجهة الويب في المتصفح (مع دعم HTML5).
3.2.وسائل التحقق من التنفيذ الصحيح للبرنامج
يتم التحقق من التشغيل الصحيح للبرنامج عن طريق تشغيل أمثلة محددة. يعرض البرنامج رسالة عند إدخال بيانات غير صحيحة (الشكل 2.20):
أرز. 2.20. إدخال رقم هاتف غير صالح
3.3. تشغيل البرنامج بعد الفشل
في حالة الإنهاء الطارئ للبرنامج لأسباب خارجية، يتم تحميل البرنامج مرة أخرى عند إزالة سبب العطل. سيتم فقدان أي بيانات لم يتم حفظها قبل الفشل.
الوصول إلى البرنامج
لبدء البرنامج عليك القيام بالخطوات التالية:
قم بتشغيل البرنامج على جهاز كمبيوتر يدعم Microsoft .NET Framework (أو على خادم بعيد)، إذا لم يكن قيد التشغيل بالفعل؛
افتح متصفحك المفضل (على سبيل المثال، chrome، internet explorer، mozilla Firefox)؛
أدخل عنوان IP الخاص بالخادم في شريط العناوين، باستخدام منفذ محدد مسبقًا؛
سيتم فتح الصفحة الرئيسية.
ابدأ العمل مع العملاء.
إذا كان البرنامج يوفر، بالإضافة إلى الاستخدام والتكوين، القدرة على كتابة كود البرنامج أو تحريره أو استخدامه. ما هي الوثيقة المطلوبة في هذه الحالة؟
مهمة دليل المبرمج
يشير دليل المبرمج إلى الوثائق التشغيلية والفنية وهو مطلوب في الحالات التي يوفر فيها النظام بطريقة أو بأخرى القدرة على كتابة كود البرنامج أو تحريره أو استخدامه.
الامثله تشمل:
- مكتبة الوظائف؛
- منصة أو بيئة لتطوير البرمجيات؛
– البرمجيات مفتوحة المصدر .
ويجب أن توفر الوثيقة جميع المعلومات اللازمة حتى يتمكن المطور من الاستفادة من إمكانيات النظام. لحل هذه المشكلة، قد تتضمن محتويات المستند ما يلي:
- الغرض وهيكل بيانات الإدخال والإخراج لوظائف البرنامج؛
- القدرة على إنشاء كود البرنامج، وميزات تفسيره وتجميعه؛
- السمات النحوية للغة البرمجة المستخدمة؛
- القواعد والقيود المحتملة عند العمل مع رمز البرنامج؛
- تعليمات مختلفة للعمل مع البرنامج.
قائمة المواضيع المحتملة لا تقتصر على هذا، كل هذا يتوقف على خصائص نظام معين. يجب أن يقال أن دليل المبرمج يمكن أن يكون مفيدًا جدًا لمطوري النظام، حيث يعمل كمرجع للتنفيذ الحالي لمنطق تشغيل البرنامج.
تكوين دليل مبرمج قياسي
وفقًا لمتطلبات GOST، يجب أن يحتوي دليل المبرمج على الأقسام التالية:
– الغرض وشروط استخدام البرنامجحيث تشير إلى نطاق البرنامج والمتطلبات الفنية اللازمة لتشغيله.
– خصائص البرنامجحيث يصفون طريقة تشغيل البرنامج ومؤشرات السرعة الخاصة به وغيرها من الخصائص المهمة للاستخدام.
– الوصول إلى البرنامجحيث تشير إلى طرق ومعلمات إطلاق البرنامج؛
– بيانات الإدخال والإخراجحيث تصف التنسيق وطريقة التنظيم والمتطلبات الأخرى لبيانات الإدخال والإخراج؛
– رسائلوالذي يوفر نصوص الرسائل التي يصدرها البرنامج في مختلف المواقف والإجراءات التي يجب اتخاذها.
يُنصح بتقديم أمثلة ورسوم توضيحية وجداول مختلفة في ملاحق الوثيقة.
معايير دليل المبرمج
تنظم GOSTs أيضًا هذه الوثيقة، وفي هذه الحالة هي GOST 19.504. ووفقاً له، يتم تحديد هيكل ومحتوى دليل المبرمج.
تكلفة تطوير دليل المبرمج
يتطلب عمل إنشاء دليل للمبرمج متخصصين مؤهلين تأهيلا عاليا ومعرفة في مجال البرمجة، ومع ذلك، بالنسبة للمطورين المحترفين، عادة ما يبدو هذا العمل مملا ومملا، علاوة على ذلك، فإنه يتطلب القدرة على صياغة المواد بكفاءة ونقلها بوضوح. يتمتع متخصصو TechRightConsult بخبرة واسعة في كلا المجالين، مما يسمح لنا بإنشاء المستندات بسعر مناسب وفي الوقت المحدد!
يشير دليل المبرمج إلى الوثائق التشغيلية والتقنية. يتم تطوير مثل هذه الوثيقة لمنتجات البرمجيات. مخصص للتعريف بالمبرمج الذي سيحل بعض المشكلات المتعلقة بتشغيل هذا البرنامج.
متى تكون هناك حاجة لتوجيهات المبرمج؟
هناك حاجة إلى توجيهات المبرمج في عدة حالات:
البرنامج الذي يتم تجميع الوثائق له هو بيئة تطوير أو مكتبة.
يوفر منتج البرنامج هذا منصة لكتابة البرامج أو الأنظمة القياسية.
يتم توزيع المنتج مع رمز البرنامج، أو يتم تعديله باستمرار بواسطة المطور.
بمساعدة مثل هذه الوثيقة، يجب تزويد المبرمج بجميع المعلومات اللازمة التي يمكن استخدامها لإنشاء منتجات البرامج الخاصة به على أساس هذا النظام. يجب توفير المعلومات بكمية كافية. يتمتع المطورون، بمساعدة دليل المبرمج، بفرصة تسجيل الحالة الحالية للمنتج الذي تم إصداره لتجنب الارتباك عند إصدار منتجات جديدة.
تشمل المهام النموذجية لمثل هذه الوثيقة ما يلي:
توضيح وشرح للمتخصص الحالة الراهنة للأشياء ومواقعها وطرق التفاعل. كما يجب على إدارة المبرمج أن تميز بوضوح بين الكائنات التي تم تضمينها في البداية في النظام والكائنات التي ينشئها المبرمج بشكل مستقل.
قائمة بأدوات التطوير الإضافية التي ستكون مطلوبة عند العمل، بالإضافة إلى المنتج الحالي.
توضيح متطلبات النظام وبيئة البرامج والأدوات اللازمة للإطلاق.