قواعد لإعداد وثائق البرنامج. تسجيل وثائق البرنامج وفقًا لـ espd و espd. تسجيل توثيق البرنامج وفقًا لـ gost

برامج الوسائل التقنية ، والبرامج الأخرى ، والخصائص العامة لمعلومات المدخلات والمخرجات ، وكذلك المتطلبات والشروط ذات الطبيعة التنظيمية والتقنية والتكنولوجية ، وما إلى ذلك).

على سبيل المثال: يتم تشغيل البرنامج على جهاز كمبيوتر شخصي (PC) من نوع IBM PC / AT. للعمل في وضع الحوار ، يتم استخدام شاشة عرض ولوحة مفاتيح وماوس. مطلوب محول EGA (VGA) لدعم وضع الرسومات. يتم تخزين بيانات الإدخال على قرص مرن و / أو محركات أقراص ثابتة. يعمل البرنامج تحت نظام التشغيل ...

يمكن تضمين المواد المرجعية (الرسوم التوضيحية والجداول والرسوم البيانية والأمثلة وما إلى ذلك) في ملحق الوصف.

ولا تنس الإشارة إلى اسم وحدة التحميل ، بالإضافة إلى وصف الإجراء بأكمله للاتصال وتحميل النظام.

على سبيل المثال: يتم تحميل البرنامج عن طريق كتابة في سطر أوامر DOS اسم الوحدة النمطية القابلة للتمهيد - SBM80N.EXE ، وربما تحديد اسم ملف البيانات.

نص البرنامج (GOST 19.401-78)

تعتبر متطلبات تنسيق نص البرنامج بسيطة للغاية وطبيعية للمبرمج المختص. الشيء الرئيسي الذي يجب إرشادك عند إنشاء هذا المستند هو أن نص البرنامج يجب أن يكون قابلاً للقراءة.

لا يزال من الضروري إعداد الجزء الإعلامي - التعليق التوضيحي والمحتوى.

يجب أن يتكون الجزء الرئيسي من المستند من نصوص قسم واحد أو أكثر ، والتي يتم منحها عناوين.

يبدأ نص كل ملف برنامج بـ "header" ، والذي يشير إلى:

· اسم البرنامج

· تاريخ إنشاء البرنامج ،

رقم الإصدار،

· تاريخ آخر تعديل.

التعليقات مطلوبة ، وكذلك التقيد الصارم بقواعد المسافة البادئة. تذكر أنه يمكنك حتى تبرير عدم القدرة على إنشاء وثائق البرنامج. والنص القبيح للبرنامج ابدا. الإشارات إلى حقيقة أن هذا النص مفهوم للمؤلف نفسه لا تؤخذ على محمل الجد. يجب ألا تخجل من السماح للآخرين بقراءة نصوص البرامج.

البرنامج وإجراءات الاختبار (GOST 19.301-79)

يحتوي هذا المستند على وصف لما يجب القيام به وكيفية القيام به للتأكد (وإقناع العميل) أن البرنامج يعمل بشكل صحيح. في الواقع ، هذه الوثيقة حاسمة للقبول

الاختبارات. يعد البرنامج المصمم جيدًا ومنهجية الاختبار ضمانًا لتوقيع شهادة القبول ، أي من أجلها قضيت الكثير من الوقت والجهد.

رسميًا ، يتم استخدام GOST لتطوير وثائق التخطيط وإجراء أعمال الاختبار لتقييم جاهزية وجودة نظام برمجي. يحتوي المستند على وصف للكائن والغرض من الاختبار ، ومتطلبات البرنامج وتوثيق البرنامج ، ووسائل وإجراءات الاختبار ، بالإضافة إلى وصف لحالات الاختبار.

الأجزاء المكونة لهذا المستند أسهل وأكثر وضوحًا لوصفها على الفور في شكل أمثلة.

كائن الاختبار

مثال: كائن الاختبار هو برنامج ... مخصص له

الغرض من الاختبارات

مثال: التحقق من موثوقية البرنامج.

متطلبات البرنامج

مثال: يجب ألا يؤدي تشغيل البرنامج إلى تعطل (عطل فادح في النظام). يجب أن يوفر تنظيم الحوار الحماية من إدخال بيانات غير صحيحة. يجب أن يصدر البرنامج تشخيصات لحالة النظام ورسائل حول أي أخطاء حدثت ... وهكذا.

متطلبات توثيق البرامج

مثال: تكوين وثائق البرنامج المقدمة أثناء الاختبار:

· وصف البرنامج (GOST 19.402-78);

· برنامج الاختبار ومنهجيته (GOST 19.301-79);

· نص البرنامج (GOST 19.401-78).

الوسائل وإجراءات الاختبار

مثال: يعمل البرنامج وفقًا لشروط تشغيل MS DOS (إصدار لا يقل عن 3.0) على كمبيوتر شخصي مثل IBM PC / AT ، وكذلك على الأجهزة المتوافقة. محول مطلوب أيضًا للتشغيل.

إجراء الاختبار:

1. تم إطلاق البرنامج من قبل….

2. محدد ...

3. الضغط ...

4. تم التحديد بالتتابع ...

حالات تجريبية

مثال: للاختبار ، يتم تقديم ... ، ووصف الذي يرد في الملفات ... محتويات ملفات الاختبار ونتائج البرنامج موجودة في الملحق 1.

وأخيرًا ، ضع في اعتبارك آخر معيار ESPD الذي يهمنا ، والذي يسمى

متطلبات مستندات البرنامج التي تم إجراؤها بطريقة الطباعة (GOST 19.106-78)

يحدد المعيار القواعد الخاصة بتنفيذ مستندات البرنامج لأجهزة الكمبيوتر والمجمعات والأنظمة ، بغض النظر عن الغرض منها ونطاقها ووفقًا لمعايير ESPD.

المتطلبات العامة.من الضروري الدخول في مستندات البرنامج المنفذة بالطرق الكتابية والآلية والكتابة بخط اليد والكلمات الفردية والصيغ والعلامات التقليدية (يدويًا بخط الرسم) وحروف الأبجدية اللاتينية واليونانية ، وكذلك لتنفيذ المخططات والرسومات بالحبر الأسود أو الحبر.

يُسمح بتصحيح الأخطاء المطبعية والرسومات التي تم العثور عليها أثناء التنفيذ عن طريق مسح جزء من النص تم تنفيذه بشكل سيئ (الرسم) وتطبيق النص المصحح (الرسومات) على نفس ورقة النص (الرسومات) بالحبر المطبوع أو الأسود ، اعتمادًا على طريقة تنفيذ المستند.

لا يُسمح بإتلاف أوراق المستندات والبقع وآثار النص المحذوف غير الكامل (الرسومات).

يتم وضع وثائق البرنامج على أوراق A4. إلا

· يُسمح بالتسجيل على أوراق بتنسيق A3 ؛

· باستخدام طريقة الآلة في تنفيذ المستندات ، يُسمح بالانحرافات في أحجام الأوراق المقابلة لتنسيقات A4 و A3 ، والتي تحددها إمكانيات الوسائل التقنية المستخدمة ؛ على أوراق من تنسيقات A4 و A3 ، المنصوص عليها في خصائص الإخراج لأجهزة إخراج البيانات ، في تصنيع مستند عن طريق الجهاز ؛

· عند عمل مستند بطريقة الطباعة ، من الممكن استخدام أوراق ذات تنسيقات مطبعية.

يتم ترتيب مواد وثيقة البرنامج بالتسلسل التالي:

· جزء العنوان:

- ورقة الموافقة (غير مدرجة في العدد الإجمالي لأوراق الوثيقة) ؛

- صفحة العنوان (الصفحة الأولى من المستند) ؛

· الجزء الإعلامي:

حاشية. ملاحظة؛

- ورقة المحتوى

· الجزء الرئيسي:

- نص المستند (بالصور والجداول وما إلى ذلك) ؛

- قائمة المصطلحات وتعريفاتها ؛

- قائمة الاختصارات

التطبيقات ؛

- دليل الموضوع؛

- قائمة الوثائق المرجعية؛

· جزء من تسجيل التغييرات:

- تغيير ورقة التسجيل.

بناء وثيقة.إذا لزم الأمر ، يُسمح بتقسيم المستند إلى أجزاء. يتم التقسيم إلى أجزاء على مستوى لا يقل عن القسم. يتم إكمال كل جزء على حدة ، بينما في نهاية محتوى الجزء الأول ، يجب سرد أسماء الأجزاء المتبقية.

يُسمح بتضمين أجزاء الوثيقة من نص البرنامج ، الذي تم وضعه وفقًا لقواعد اللغة التي يُكتب بها نص البرنامج.

يتم وضع التعليق التوضيحي في صفحة (صفحات) منفصلة ، مزودة بالعنوان "ANNOTATION" ، مرقمة ومضمنة في محتوى المستند.

يتم تقسيم نص كل وثيقة ، إذا لزم الأمر ، إلى فقرات وفقرات - إلى فقرات فرعية ، بغض النظر عما إذا كان المستند مقسمًا إلى أجزاء وأقسام وأقسام فرعية أم لا.

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

يجب ترقيم الأقسام والأقسام الفرعية والبنود والفقرات بالأرقام العربية مع نقطة. يجب أن تحتوي الأقسام على رقم تسلسلي (1 ، 2 ، إلخ.)

نص المستند.يجب أن يكون نص الوثيقة قصيرًا وواضحًا ويستبعد احتمال سوء التفسير. يجب أن تكون المصطلحات والتعريفات موحدة ومتوافقة مع المعايير المعمول بها ، وفي حالة عدم وجودها - مقبولة بشكل عام في الأدبيات العلمية والتقنية ، ويجب تقديمها في قائمة المصطلحات.

يمكن صياغة التفسيرات اللازمة لنص الوثيقة مع الحواشي السفلية. تتم الإشارة إلى الحاشية السفلية برقم يحتوي على أقواس موضوعة على مستوى خط الاقتصاص العلوي للخط.

إذا كانت الحاشية تشير إلى كلمة منفصلة ، يتم وضع علامة الحاشية السفلية بجوار هذه الكلمة مباشرة ، ولكن إذا كانت تشير إلى الجملة ككل ، فعندئذٍ في نهاية الجملة. يتم وضع نص الحاشية السفلية في نهاية الصفحة ويتم فصله عن النص الرئيسي بخط 3 سم مرسوم على الجانب الأيسر من الصفحة.

الرسوم التوضيحية. يمكن وضع الرسوم التوضيحية في نص المستند و / أو في الملاحق. الرسوم التوضيحية ، إذا كان هناك أكثر من واحدة في هذا المستند ، يتم ترقيمها بالأرقام العربية في جميع أنحاء المستند.

في الملاحق ، يتم ترقيم الرسوم التوضيحية داخل كل ملحق بالترتيب المحدد للنص الرئيسي للوثيقة. ترد الإشارات إلى الرسوم التوضيحية حسب النوع: "الشكل 12" أو "(الشكل 12)". يمكن أن تحتوي الرسوم التوضيحية على عنوان موضوعي ونص صورة يشرح محتوى الرسم التوضيحي.

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

ترد الإشارات في النص إلى الرقم الترتيبي للصيغة بين قوسين ، على سبيل المثال: "في الصيغة (3)". عند تقسيم مستند إلى أجزاء ، يتم وضع رقم الجزء قبل الرقم التسلسلي للصيغة ويفصل عن آخر نقطة ، على سبيل المثال: "في الصيغة (1.4)".

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

الروابط. يُسمح بالإشارات إلى المعايير والمستندات الأخرى في وثائق السياسة. يجب الإشارة إلى الوثيقة ككل أو إلى أقسامها (مع الإشارة إلى تسمية وعنوان الوثيقة ورقم وعنوان القسم أو التطبيق).

يُسمح بالإشارة فقط إلى تسمية المستند و (أو) الأقسام دون الإشارة إلى أسمائهم. لا يُسمح بالإشارة إلى الأقسام الفرعية والفقرات والرسوم التوضيحية الفردية لوثيقة أخرى. يُسمح بالإشارة إلى الفقرات والتوضيحات والأقسام الفرعية الفردية داخل المستند.

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

الاختصارات. لا يُسمح باختصارات الكلمات في النص والتعليقات التوضيحية تحت الرسوم التوضيحية ، باستثناء:

· الاختصارات التي تم إنشاؤها في GOST 2.316-68 ، ومقبولة بشكل عام باللغة الروسية ؛

· تستخدم الاختصارات للدلالة على البرامج وأجزائها

و أوضاع التشغيل ، في لغات التحكم في العمل ، في إعدادات البرامج ، وما إلى ذلك ، يُشار إليها بأحرف لاتينية

الأبجدية.

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

يجب أن يبدأ كل تطبيق في صفحة جديدة بها كلمة "Application" في الزاوية اليمنى العليا وأن يكون لها عنوان موضوعي. في حالة وجود أكثر من مرفق واحد في المستند ، يتم ترقيم جميع المرفقات بالأرقام العربية (بدون علامة "#") ، على سبيل المثال:

الملحق 1 ، الملحق 2 ، إلخ.

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

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

تشير وثائق المستخدم إلى الوثائق التي تزود المستخدم النهائي بمعلومات حول تثبيت حزمة البرامج وتشغيلها. تُفهم المعلومات الموجودة على العبوة على أنها المعلومات المستنسخة على العبوة الخارجية لحزمة البرنامج. والغرض منه هو تزويد المشترين المحتملين بالمعلومات الأولية حول حزمة البرامج.

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

مع أنظمة أخرى). تتناول هذه المستندات جزئيًا مشكلات صيانة البرامج ، ولكنها لا تتناول المشكلات المتعلقة بـ

مع تعديل البرامج.

الخامس في هذا الصدد ، يجب التمييز بين فئتين من المستخدمين: مستخدمي البرنامج العاديين والمسؤولين. مستخدم عادي للبرنامج(المستخدم النهائي) يستخدم البرنامج لحل مشاكله (في مجال تخصصه). يمكن أن يكون هذا مهندسًا يصمم جهازًا تقنيًا ، أو أمين الصندوق يبيع تذاكر القطار باستخدام هذا البرنامج. قد لا يعرف الكثير من التفاصيل عن الكمبيوتر أو مبادئ البرمجة. يدير مسؤول البرنامج (مسؤول النظام) استخدام البرنامج من قبل المستخدمين العاديين ويحافظ على البرنامج ، وليس له علاقة بتعديل البرامج. على سبيل المثال ، يمكنه تنظيم حقوق الوصول إلى البرنامج بين المستخدمين العاديين ، أو التواصل مع موردي البرنامج ، أو تنفيذ إجراءات معينة للحفاظ على البرنامج في حالة عمل إذا تم تضمينه كجزء من نظام آخر.

يعتمد تكوين وثائق المستخدم على جماهير المستخدمين المستهدفين وعلى طريقة استخدام المستندات. الجمهور هنا يعني مجموعة المستخدمين ،

التي هناك حاجة لوثائق مستخدم معينة. تعتمد وثيقة المستخدم الناجحة بشكل أساسي على التعريف الدقيق للجمهور المقصود بها. يجب أن تحتوي وثائق المستخدم على المعلومات المطلوبة لكل جمهور. يشير وضع استخدام المستند إلى الطريقة التي تحدد كيفية استخدام المستند. عادةً ما يتطلب مستخدم أنظمة برمجية كبيرة بما يكفي إما المستندات لدراسة أداة برمجية (تستخدم كتعليمات) ، أو لتوضيح بعض المعلومات (تستخدم كمرجع).

الوصف الوظيفي العام للبرنامج. يعطي وصفًا موجزًا ​​لوظيفة أداة البرنامج. إنه مخصص للمستخدمين الذين يحتاجون إلى تحديد مدى حاجتهم إلى أداة البرنامج هذه.

دليل تثبيت البرنامج. مصمم لمسؤولي النظام. يجب أن يصف بالتفصيل كيفية تثبيت الأنظمة في بيئة معينة. يجب أن يحتوي على وصف للوسيط المقروء آليًا والذي يتم توفير البرنامج عليه ، وملفات تمثل البرنامج ، والحد الأدنى من متطلبات تكوين الأجهزة.

تعليمات استخدام البرنامج. مصممة للمستخدمين العاديين. يحتوي على المعلومات اللازمة حول استخدام البرنامج ، منظم بشكل مناسب لدراسته.

كتيب لاستخدام أدوات البرمجيات. مصممة للمستخدمين العاديين. يحتوي على المعلومات الضرورية حول استخدام البرنامج ، منظم بشكل مناسب للبحث الانتقائي للأجزاء الفردية.

دليل إدارة الأداة. مصمم لمسؤولي النظام. يجب أن يصف الرسائل التي تم إنشاؤها عندما يتفاعل البرنامج مع أنظمة أخرى وكيفية الرد على هذه الرسائل. بالإضافة إلى ذلك ، إذا كانت أداة برمجية تستخدم أجهزة نظام ، فقد يوضح هذا المستند كيفية صيانة هذا الجهاز.

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

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

1.4 دليل المبرمج

تصف وثائق النظام أداة برمجية من وجهة نظر التطوير.

يعد هذا التوثيق ضروريًا إذا كانت أداة البرنامج تتضمن دراسة كيفية ترتيبها (تصميمها) وترقية برامجها. كما لوحظ ، الصيانة هو تطور مستمر. لذلك ، إذا كان من الضروري تحديث البرنامج ، فسيتم إشراك فريق خاص من المطورين المرافقين في هذا العمل. سيتعين على هذا الفريق التعامل مع نفس الوثائق التي وجهت فريق تطوير البرامج (الأساسي) الأصلي ، مع الاختلاف الوحيد في أن هذه الوثائق ستكون عادةً غريبة على فريق الصيانة (تم إنشاؤها بواسطة فريق آخر). سيحتاج فريق تطوير المسؤول عن الصيانة إلى مراجعة هذه الوثائق لفهم بنية البرنامج الذي يتم ترقيته وعملية تطويره ، ولإجراء التغييرات اللازمة على هذه الوثائق ، مما يؤدي إلى تكرار عمليات سير العمل التي تم من خلالها إنشاء البرنامج الأصلي.

يمكن تقسيم وثائق صيانة البرامج إلى مجموعتين:

1. الوثائق التي تحدد هيكل البرامج وهياكل البيانات لأنظمة البرمجيات وتكنولوجيا تطويرها ؛

2. وثائق لمساعدتك في إجراء تغييرات على البرنامج.

تحتوي وثائق المجموعة الأولى على الوثائق النهائية لكل مرحلة تكنولوجية لتطوير البرمجيات. يتضمن الوثائق التالية.

الوصف الخارجي لأداة البرنامج (وثيقة المتطلبات). وصف بنية البرنامج (وصف النظام

العمارة) ، بما في ذلك المواصفات الخارجية لكل برنامج من برامجها.

لكل برنامج وصف لهيكله المعياري ، بما في ذلك المواصفات الخارجية لكل وحدة مدرجة فيه.

لكل وحدة - مواصفاتها ووصف هيكلها

(وصف التصميم).

نصوص الوحدة في لغة البرمجة المختارة (قوائم كود مصدر البرنامج).

وثائق التحقق من صحة تصف كيف تم إثبات الصلاحية

كل برنامج وكيف ارتبطت معلومات التحقق من الصحة بمتطلبات البرنامج.

تتضمن مستندات التحقق من الصحة بشكل أساسي وثائق الاختبار (تصميم الاختبار ووصف مجموعة الاختبار) ، ولكنها قد تتضمن نتائج أنواع أخرى من التحقق من البرامج ، مثل إثبات خصائص البرنامج.

تحتوي وثائق المجموعة الثانية على

يصف دليل صيانة النظام ، الذي يصف المشكلات المعروفة جنبًا إلى جنب مع البرنامج ، أجزاء النظام التي تعتمد على الأجهزة والبرامج ، وكيف يتم أخذ تطوير البرامج في الاعتبار في تصميمه.

تتمثل المشكلة الشائعة في الحفاظ على أداة برمجية في ضمان مواكبة جميع وجهات نظرها (الحفاظ على اتساقها) عند تغيير البرنامج. للمساعدة في ذلك ، يجب التقاط الروابط والتبعيات بين المستندات وأجزائها في قاعدة بيانات إدارة التكوين.

الخلاصة الزيادة السريعة في تعقيد وحجم المرافق الحديثة

أدت البرامج ذات الزيادة المتزامنة في مسؤولية الوظائف المؤداة إلى زيادة حادة في متطلبات العملاء والمستخدمين لجودة وسلامة الاستخدام. تعد معايير التوثيق التي تم تطويرها بمشاركة ممثلي الشركات الرائدة في الصناعة وسيلة مثبتة لضمان الكفاءة العالية والجودة لعمل البرامج وأنظمة البرمجيات.

في روسيا ، في مجال ضمان دورة حياة وجودة مجمعات البرامج المعقدة ، يتم استخدام مجموعة GOST القديمة بشكل أساسي ، والتي تتخلف عن المستوى العالمي من 5 إلى 10 سنوات.

على مدى السنوات القليلة الماضية ، تم إنشاء العديد من معايير ISO التي تنظم عمليات ومنتجات دورة حياة أدوات البرمجيات وقواعد البيانات ، والتي يمكن أن تكون بمثابة أساس لأنظمة ضمان الجودة لمنتجات البرمجيات. يجب أن تعرف جميع معايير توثيق البرامج وتستخدمها بشكل صحيح لتحسين جودة المنتج.

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 Z A S S R

نظام التوثيق الفني للبنادق ذاتية الدفع

GOST 24.207-80

المتطلبات الخاصة بمحتوى مستندات البرنامج

نظام التوثيق الفني لأنظمة التحكم بالكمبيوتر. متطلبات محتويات الوثائق على البرنامج

بموجب المرسوم الصادر عن لجنة الدولة لاتحاد الجمهوريات الاشتراكية السوفياتية للمعايير بتاريخ 14 مايو 1980 رقم 2101 ، تم تحديد فترة التقديم

من 01.01 1981

تنطبق هذه المواصفة القياسية على الوثائق الفنية لأنظمة التحكم المؤتمتة (ACS) من جميع الأنواع ، والتي تم تطويرها لجميع مستويات الإدارة (باستثناء المستوى الوطني) ، وتحدد متطلبات محتوى المستندات المدرجة ، وفقًا لـ GOST 24.101-80 ، في توثيق البرامج في مشاريع ACS.

1. أحكام عامة

1.1 وثائق البرنامج مخصصة لـ:

  • للحصول على وصف حلول تصميم البرامج في المستند "وصف برنامج ACS".
  • لتحديد متطلبات البرنامج (مجمع البرامج) في وثيقة "الاختصاصات" ؛
  • لوصف الحلول التي توفر الدعم والإنتاج والتشغيل للبرنامج (مجمع البرامج) في المستندات "مذكرة توضيحية" ، "وصف التطبيق" ، "وصف البرنامج" ، "المواصفات" ، "دليل المبرمج" ، "المشغل الدليل "،" نص البرنامج "،" النموذج "،" الإجراءات ومنهجية الاختبار "؛
  • للتحقق من أداء البرنامج (مجمع البرامج) في وثيقة "وصف حالة الاختبار".

1.2 عند تطوير المستندات من جانب ACS ، يقتصر محتوى أقسام كل وثيقة على إطار عمل الجزء المقابل.

1.3 اعتمادًا على الغرض والميزات المحددة لأنظمة التحكم الآلي التي يتم إنشاؤها ، يُسمح بتضمين أقسام إضافية في المستندات ، والتي لم يتم تحديد متطلبات محتواها بواسطة هذا المعيار. يتم تسجيل غياب حلول التصميم لقسم من المستند في القسم المقابل مع التفسيرات اللازمة.

1.4 تم تحديد متطلبات محتوى المستندات "الشروط المرجعية" ، "الملاحظة التوضيحية" ، "وصف التطبيق" ، "المواصفات" ، "دليل المشغل" ، "نص البرنامج" ، "النموذج" ، "الإجراءات ومنهجية الاختبار" من خلال GOST 19.201-78 ، GOST 19.404-79 ، GOST 19.502-78 ، GOST 19.202-78 ، GOST 19.505-79 ، GOST 19.401-78 ، GOST 19.501-78 و GOST 19.301-79.

(الطبعة المعدلة ، تعديل رقم 1).

2. متطلبات محتوى المستندات

2.1. وصف برنامج ACS

2.1.1. يجب أن يحتوي المستند على جزء تمهيدي وأقسام:

  • هيكل البرنامج
  • الوظائف الأساسية لأجزاء البرنامج ؛
  • أساليب وأدوات تطوير البرمجيات ؛
  • نظام التشغيل؛
  • الأدوات التي تعمل على توسيع قدرات نظام التشغيل.

2.1.2. يجب أن يحتوي الجزء التمهيدي على معلومات أساسية حول الدعم الفني والإعلامي والأنواع الأخرى من دعم ACS المطلوب لتطوير البرامج ، أو رابط إلى المستندات ذات الصلة لمشروع ACS.

2.1.3. يجب أن يحتوي قسم "بنية البرنامج" على قائمة بأجزاء البرامج مع الإشارة إلى العلاقات المتبادلة والأساس المنطقي لإبراز كل منها.

2.1.4. يجب أن يحتوي قسم "الوظائف الأساسية لأجزاء البرنامج" على أقسام فرعية يتم فيها تقديم الغرض ووصف الوظائف الرئيسية لكل جزء من البرنامج.

(الطبعة المعدلة ، تعديل رقم 1).

2.1.5. يجب أن يحتوي قسم "طرق وأدوات تطوير البرمجيات" على قائمة بأساليب وأدوات البرمجة لتطوير برمجيات ACS مع الإشارة إلى أجزاء البرنامج ، والتي ينبغي في تطويرها استخدام الأساليب والأدوات المناسبة.

2.1.6. يجب أن يحتوي قسم "نظام التشغيل" على:

  • الاسم والتسمية والوصف المختصر لنظام التشغيل المحدد وإصداره ، والتي سيتم تنفيذ البرامج المطورة من خلالها ، مع تبرير لاختيار المصادر والإشارة إليها ، حيث يتم تقديم وصف تفصيلي للإصدار المحدد ؛
  • اسم الدليل الذي يجب أن يتم بموجبه إنشاء الإصدار المحدد من نظام التشغيل ؛
  • متطلبات متغير إنشاء الإصدار المحدد من نظام التشغيل.

2.1.7. يجب أن يحتوي قسم "الأدوات التي تعمل على توسيع إمكانيات نظام التشغيل" على أقسام فرعية يجب فيها تحديد:

  • الاسم والتسمية ووصف موجز للمنتج مع تبرير الحاجة إلى استخدامه وبيان المصدر ، حيث يتم تقديم وصف تفصيلي للمنتج المحدد ؛
  • اسم الدليل ، وفقًا للأداة المستخدمة التي يجب تكوينها لتطبيق معين ؛
  • متطلبات إعداد الأداة التي تستخدمها.

2.2. وصف البرنامج

2.2.2. بالنسبة للبرنامج (مجمع البرامج) الذي تم الحصول عليه من خلال استخدام برنامج تم تطويره مسبقًا ، يجب استكمال وثيقة "وصف البرنامج" بقسم "تكوين البرامج".

2.2.3. يجب أن يحتوي قسم "إعدادات البرنامج" على:

  • الاسم ، وتسمية أدوات البرمجيات المستخدمة ، ووصف للإجراءات المطلوبة لتخصيصها ، أو روابط إلى الوثائق التشغيلية لهذه الأدوات ؛
  • قائمة عناصر أدوات البرمجيات المستخدمة والضرورية للحصول على البرنامج (مجمع البرامج) ؛
  • وصف الإعداد باللغة المحددة في وثائق التشغيل للبرنامج المستخدم.

2.3 دليل المبرمج

2.3.1. يجب أن يتوافق المستند الخاص بتكوين الأقسام ومحتواها مع GOST 19.504-79 ، بالإضافة إلى ذلك ، يتضمن قسم "معلومات عن شكل عرض البرنامج (مجمع البرامج)".

2.3.2. يجب أن يحتوي القسم "معلومات حول شكل عرض البرنامج (مجمع البرامج)" على معلومات حول الوسيط الذي يتم تسجيل البرنامج عليه ، وحول المحتوى ونظام ترميز المعلومات المسجلة على الوسيط ، وكذلك المعلومات اللازمة لقراءة المعلومات من الوسط.

2.3.3. بالنسبة للبرنامج (مجمع البرامج) الذي يمكن تهيئته لشروط تطبيق معين ، تتضمن وثيقة "دليل المبرمج" الأقسام التالية:

  • هيكل البرنامج.
  • إعداد البرنامج ؛
  • ميزات إضافية؛
  • رسائل إلى مبرمج النظام.

2.3.4. يُسمح لبرنامج (مجمع البرامج) الذي يمكن تهيئته لتطبيق معين ، بدلاً من الأقسام المذكورة في الفقرة 2.3.3 ، لتطوير مستند منفصل "دليل مبرمج النظام" يفي بمتطلبات GOST 19.503-79 .

2.4 وصف حالة الاختبار

2.4.1. يجب أن يحتوي المستند على أقسام:

  • موعد؛
  • البيانات الأولية؛
  • نتائج الحساب
  • التحقق من البرنامج (مجمع البرامج).

2.4.2. يجب أن يحتوي قسم "الغرض" على قائمة بالمعلمات ووصف موجز للوظيفة ، من بين تلك التي ينفذها البرنامج (مجمع البرامج) ، التي تم التحقق منها في حالة الاختبار.

2.4.3. يجب أن يحتوي قسم "البيانات الأولية" على وصف للبيانات الأولية لفحص البرنامج (مجمع البرامج) بالبيانات الأولية. يُسمح بتقديم البيانات الأولية في شكل نسخة مطبوعة من جامعة أبوظبي.

2.4.4. يجب أن يحتوي قسم "نتائج الحساب" على نتائج معالجة البيانات الأولية بواسطة البرنامج (مجموعة البرامج) ، مما يسمح بتقييم صحة الوظائف المختبرة وقيمة المعلمات التي تم التحقق منها. يُسمح بإعطاء نتائج الحساب في شكل نسخة مطبوعة من ADCU.

2.4.5. يجب أن يحتوي قسم "التحقق من برنامج (مجمع البرامج)" على:

  • وصف لتكوين الوسائل التقنية اللازمة لتشغيل البرنامج (مجموعة البرامج) ، أو رابط لوثائق البرنامج المقابلة ؛
  • وصف لإجراءات إنشاء البيانات الأولية للتحقق من البرنامج (مجمع البرامج) ، واستدعاء البرنامج الذي يتم فحصه (معقد من البرامج) والحصول على نتائج الحساب ؛
  • وصف لإجراءات المشغل عند إعداد البيانات الأولية والتحقق من البرنامج (مجمع البرامج) باستخدام مثال اختبار.
* أعيد طبعه (مايو 1986) مع التعديل رقم 1 ، تمت الموافقة عليه في أغسطس 1985 (IUS 11-85).
الى القمة

GOST 19.105-78 * (المتطلبات العامة لوثائق البرنامج)

من هذا GOST نحصل عليهالمتطلبات العامة لتصميم وثائق البرنامج.فيما يلي أهم الأقسام.

  • يحدد هذا المعيار المتطلبات العامة لتصميم مستندات البرامج لأجهزة الكمبيوتر والمجمعات والأنظمة ، بغض النظر عن الغرض منها ونطاقها ووفقًا لمعايير نظام توثيق البرمجة الموحد (ESPD) لأي طريقة لتنفيذ المستندات على ناقلات البيانات المختلفة.
  • تتكون وثيقة البرنامج من الأجزاء الشرطية التالية:
    • لقب؛
    • معلوماتية؛
    • أساسي؛
    • تسجيل التغييرات.
  • يتكون جزء العنوان من ورقة بيان وصفحة عنوان. تم وضع قواعد إعداد ورقة الموافقة وصفحة العنوان وفقًا لـ GOST 19.104-78.
  • جزء المعلوماتيجب أن يتكون من تعليق توضيحي ومحتوى.
    • تم تحديد الحاجة إلى تضمين الجزء الإعلامي في أنواع مختلفة من وثائق البرنامج من خلال معايير EAPD ذات الصلة لهذه الوثائق.
    • يوفر التعليق التوضيحي معلومات حول الغرض من المستند وملخصًا لجزءه الرئيسي.
    • يتضمن المحتوى قائمة من السجلات حول العناصر الهيكلية للمحتوى الرئيسي للمستند ، ويتضمن كل منها:
      • تعيين عنصر هيكلي (رقم القسم ، القسم الفرعي ، إلخ) ؛
      • اسم العنصر الهيكلي ؛
      • عنوان العنصر الهيكلي في ناقل البيانات (على سبيل المثال ، رقم الصفحة ورقم الملف وما إلى ذلك).
  • تم تحديد تكوين وهيكل الجزء الرئيسي من وثيقة البرنامج من خلال معايير ESPD للوثائق ذات الصلة.
  • جزء من تسجيل التغييرات(يجب تضمينها في كل وثيقة سياسة)
    • يتم تسجيل كل تغيير في وثيقة البرنامج في هذا الجزء وفقًا لمتطلبات GOST 19.603-78.
الى القمة
==================================
GOST 19.106-78 * (المتطلبات العامة لوثائق البرنامج المطبوعة
طريق)
من هذا GOST نحصل عليهقواعد عامة لطريقة الطباعة المطبوعةوثائق السياسة. فيما يلي أهم الأقسام.
  • يحدد هذا المعيار القواعد الخاصة بتنفيذ مستندات البرامج لأجهزة الكمبيوتر والمجمعات والأنظمة ، بغض النظر عن الغرض منها ونطاقها ووفقًا لمعايير نظام توثيق البرمجة الموحد (ESPD) للطريقة المطبوعة للتنفيذ.
  • لا ينطبق المعيار على وثيقة البرنامج "نص البرنامج".
  • تم إنشاء تكوين وهيكل وثيقة البرنامج وفقًا لـ GOST 19.105-78.
  • تم تنفيذ وثيقة البرنامجعلى جانب واحد من الورقة ، على فترتين ؛ مسموح به على فاصل زمني واحد أو واحد ونصف.
  • يتم إعداد وثائق البرنامج:
    • على أوراق A4 (GOST 2.301-68) - عند عمل مستند بالطريقة الكتابية أو المكتوبة بخط اليد (النموذج 1). يُسمح بالتسجيل على أوراق من تنسيق A3.


  • مواد وثيقة البرنامج مرتبة بالتسلسل التالي:
    • جزء العنوان:
      • ورقة الموافقة (غير مدرجة في العدد الإجمالي لأوراق الوثيقة) ؛
      • صفحة العنوان (الصفحة الأولى من المستند) ؛
    • الجزء الإعلامي:
      • حاشية. ملاحظة؛
      • ورقة المحتوى
    • الجزء الرئيسي:
      • نص المستند (بالصور والجداول وما إلى ذلك) ؛
      • التطبيقات ؛
      • قائمة المصطلحات ، قائمة الاختصارات ، قائمة الأشكال ، قائمة الجداول ، فهرس الموضوع ، قائمة الوثائق المرجعية ؛
    • جزء من تسجيل التغييرات:
      • تغيير ورقة التسجيل.
  • يتم وضع التعليق التوضيحي في صفحة منفصلة (مرقمة) بالعنوان "ANNOTATION" ولا يتم ترقيمها كقسم.
    • يشير التعليق التوضيحي إلى إصدار البرنامج ، ويصف بإيجاز الغرض من المستند ومحتواه. إذا كان المستند يتكون من عدة أجزاء ، فيتم توضيح العدد الإجمالي للأجزاء في التعليق التوضيحي.
  • يتم وضع محتوى المستند في صفحة (صفحات) منفصلة (مرقمة) بعد التعليق التوضيحي ، مع توفير العنوان "CONTENT" ، وليس مرقمًا كقسم ويتم تضمينه في العدد الإجمالي لصفحات المستند.
  • تتم كتابة عناوين الأقسام بأحرف كبيرة ويتم وضعها بشكل متماثل بالنسبة إلى الحدود اليمنى واليسرى للنص.
  • تتم كتابة عناوين الأقسام الفرعية مع فقرة بأحرف صغيرة (باستثناء الأحرف الكبيرة الأولى).
  • لا يُسمح باستخدام الواصلة في العناوين. لا تضع نقطة في نهاية العنوان.
  • يجب أن تكون المسافة بين العنوان والنص التالي ، وكذلك بين عناوين القسم والأقسام الفرعية ، مساوية لـ:
    • عند تنفيذ المستند بطريقة مطبوعة - فترتان.
  • بالنسبة للأقسام والأقسام الفرعية ، التي يكون نصها مكتوبًا على نفس الصفحة مع نص القسم السابق ، يجب أن تكون المسافة بين آخر سطر من النص والعنوان التالي مساوية:
    • عند تنفيذ مستند بالطريقة الكاتبة - ثلاث فواصل زمنية مطبوعة.
  • يجب ترقيم الأقسام والأقسام الفرعية والبنود والفقرات بالأرقام العربية مع نقطة.
  • يجب أن يكون هناك ترقيم مستمر داخل القسم لجميع الأقسام الفرعية والبنود والبنود الفرعية المدرجة في هذا القسم.
  • يتضمن ترقيم الأقسام الفرعية رقم القسم والرقم الترتيبي للقسم الفرعي المتضمن في هذا القسم ، مفصولة بنقطة (2.1 ؛ 3.1 ، إلخ).
  • في حالة وجود أقسام وأقسام فرعية ، تتم إضافة الرقم التسلسلي للفقرة والفقرة الفرعية (3.1.1 ، 3.1.1.1 ، إلخ) إلى رقم القسم الفرعي بعد النقطة.

مثال على هيكل نص وثيقة البرنامج وترقيم الأقسام والأقسام الفرعية والبنود والفقرات الفرعية.

  • يجب أن يكون نص الوثيقة قصيرًا وواضحًا ويستبعد احتمال سوء التفسير.
  • يجب أن تكون المصطلحات والتعريفات موحدة ومتوافقة مع المعايير المعمول بها ، وفي حالة عدم وجودها - مقبولة بشكل عام في الأدبيات العلمية والتقنية ، ويجب تقديمها في قائمة المصطلحات.
  • يمكن صياغة التفسيرات اللازمة لنص الوثيقة مع الحواشي السفلية.
    • يتم الإشارة إلى الحاشية السفلية برقم مع وضع قوس على مستوى الحافة العلوية للخط ، على سبيل المثال: "جهاز الطباعة 2) ..." أو "الورقة 5)".
    • إذا كانت الحاشية تشير إلى كلمة منفصلة ، يتم وضع علامة الحاشية السفلية بجوار هذه الكلمة مباشرة ، ولكن إذا كانت تشير إلى الجملة بأكملها ، فعندئذٍ في نهاية الجملة. يتم وضع نص الحاشية السفلية في نهاية الصفحة ويتم فصله عن النص الرئيسي بخط 3 سم مرسوم على الجانب الأيسر من الصفحة.
  • الرسوم التوضيحية ، إذا كان هناك أكثر من واحدة في هذا المستند ، يتم ترقيمها بالأرقام العربية في جميع أنحاء المستند.
  • يتم ترقيم الصيغ في المستند ، إذا كان هناك أكثر من واحد ، بالأرقام العربية ، ويتم وضع الرقم على الجانب الأيمن من الصفحة ، بين قوسين على مستوى الصيغة.
  • يجب إعطاء معنى الرموز والمعاملات العددية المضمنة في الصيغة مباشرة أسفل الصيغة. تتم طباعة معنى كل حرف على سطر جديد بالترتيب الذي وردت به في الصيغة. يجب أن يبدأ السطر الأول من فك التشفير بكلمة "حيث" ، بدون نقطتين بعدها.
  • يُسمح بالإشارات إلى المعايير (باستثناء معايير المؤسسة) والمواصفات الفنية والوثائق الأخرى (على سبيل المثال ، وثائق هيئات الإشراف الحكومية ، وقواعد ومعايير اتحاد الجمهوريات الاشتراكية السوفياتية Gosstroy) في وثائق البرنامج. عند الإشارة إلى المعايير والمواصفات ، وضح تسميتها.
  • يجب الإشارة إلى الوثيقة ككل أو إلى أقسامها (مع الإشارة إلى تسمية وعنوان الوثيقة ورقم وعنوان القسم أو التطبيق). عند إعادة الإشارة إلى قسم أو ملحق ، يشار فقط إلى الرقم.
  • في الملاحظات على النص والجداول ، يشار فقط إلى البيانات المرجعية والتفسيرية.
    • ملاحظة واحدة غير مرقمة. بعد كلمة "ملاحظة" ضع نقطة.
    • يجب ترقيم العديد من الملاحظات بأرقام عربية متسلسلة مع نقطة. يتم استخدام النقطتين بعد كلمة "ملاحظة".
  • لا يُسمح باختصارات الكلمات في النص والتعليقات التوضيحية أسفل الرسوم التوضيحية.
  • يجوز إصدار مواد أو جداول أو نص إضافي مصور في شكل مرفقات.
  • يجب أن يبدأ كل ملحق في صفحة جديدة مع الإشارة إلى كلمة "ملحق" في الزاوية اليمنى العليا وأن يكون له عنوان موضوعي مكتوب بشكل متماثل مع النص بأحرف كبيرة.(في النهاية ، لإنشاء مشروع ، نحتاج فقط إلى ورقة تسجيل التغيير).
    • يحدد هذا المعيار القواعد لإجراء تغييرات على مستندات البرنامج المنصوص عليها في معايير نظام توثيق البرمجة الموحد (ESPD) ويتم تنفيذها في الطباعة.
    نظرًا للكم الهائل من المعلومات في GOST ولتوفير مساحة على هذه الصفحة ، أوصيك بالاطلاع بشكل مستقل GOST 19.604-78 * ... مثال جاهز للتصميم"تغيير ورقة التسجيل"يمكنك الاطلاع على أي وثيقة سياسة متوفرة في قسم التنزيل

    الى القمة
    ==================================

قواعد ومتطلبات التسجيل لمحتوى الدورات الدراسية

الإصدار 2

المشاريع (الأعمال) وأعمال التأهيل النهائية

صفحة 39 من 73

رسم تجميعي لوحدة التجميع

تحت رقم 8 مدرج في المنتج 1

PC.760108.000 SB

رسم التجميع لتجميع منفصل

الوحدات 4

PC.760004.000 SB

منظر عام رسم لتجميع منفصل

الوحدات 4

الكمبيوتر 760004.000 صوت

تم تضمين رسم الجزء رقم 16 في

وحدة التجميع 8 المنتج 1

رسم الجزء رقم 120 ، متضمن في

وحدة تجميع منفصلة 4

رسم تخطيطي كهربائي للمنتج 1

PC.760100.000 E3

مخطط حركي ، مبدأ ، منفصل

وحدة التجميع 4

PK.760400.000 K3

مواصفات وحدة التجميع 8 المنتج 1

10 تسجيل الوثائق التكنولوجية

10.1 يتم وضع الوثائق التكنولوجية لمشاريع الدورة (الأعمال) وأعمال التأهيل النهائية وفقًا لمتطلبات معايير ESTD.

10.2 يجب أن تتضمن الوثائق التكنولوجية:

صفحة العنوان ، مصممة وفقًا لـ GOST 3.1105 - 84 "ESTD. شكل وقواعد إعداد الوثائق العامة "(نموذج 2 أ).

خريطة الطريق ، الصادرة وفقًا لـ GOSTمن 3.1118 إلى 82 "بتوقيت شرق الولايات المتحدة. نماذج وقواعد تسجيل خرائط الطريق "؛

مخططات تشغيل الآلات ومخططات التشغيل

البطاقات الحسابية والتكنولوجية للعمليات التكنولوجية ، على آلات CNC - وفقًا لـ GOST 3.1404-86 "ESTD. أشكال وقواعد الأعمال الورقية للعمليات التكنولوجية وعمليات القطع "؛

بطاقات تشغيل الأقفال،أعمال التركيب والتركيب وفقًا لـ GOST 3.1407-86 “ESTD. نماذج ومتطلبات إكمال وتنفيذ المستندات للعمليات التكنولوجية (العمليات) ، المتخصصة حسب طرق التجميع "؛

خرائط الرسومات (إذا لزم الأمر) وفقًا لـ GOST 3.1105-84 و GOST 3.1128-93 "ESTD. القواعد العامة لتنفيذ الوثائق التكنولوجية الرسومية "؛

المخططات التشغيلية للتحكم التكنولوجي وفقًا لـ GOST 3.1502-85 "بالتوقيت الرسمي الشرقي. نماذج وقواعد الأعمال الورقية للمراقبة الفنية "؛

الوثائق التكنولوجية الأخرى (إذا لزم الأمر أو بقرار من مدير المشروع).

10.3 يتم تنفيذ رسومات الإصلاح وفقًا للقواعد المنصوص عليها في GOST 2.604-88 "رسومات الإصلاح".

10.4 يجب أن تكون الوثائق التكنولوجية ملزمة

مباشرة في المذكرة التوضيحية للدورة (المشروع) أو بعد الملاحق والمواصفات وقوائم العناصر. الوثائق التكنولوجية لها ترقيمها الخاص.

11- تسجيل وثائق البرنامج

11.1 يجب إعداد المستندات الخاصة بمجالات المشكلات المختلفة التي تم تطويرها في مشاريع الدورة التدريبية (الأعمال) وأعمال التأهيل النهائية على النحو التالي:

وثائق البرنامج - وفقًا لمتطلبات ESPD ،

مستندات نظام التحكم الآلي - وفقًا لمعايير الدولة لنظام التوثيق التكنولوجي لنظام التحكم الآلي. 11.2 يجب أن تتضمن وثائق البرنامج (قوائم البرنامج) ما يلي:

نص البرنامج ، الذي تم إعداده وفقًا لـ GOST 19.401 ؛

وصف البرنامج ، وفقًا لـ GOST 19.402 ؛

وصف المذكرة المقدمة وفقًا لـ GOST 19.502 ؛

وثائق سياسة أخرى (إذا لزم الأمر).

11.3 يتم وضع قوائم البرامج في مرفقات مع روابط إلزامية لها في PP.

11.4 يمكن أن يكون رمز البرنامج مصحوبًا بتعليقات. عند تصميم القوائم ، يوصى باستخدام خط Courier New ، الحجم - 12 نقطة ، تباعد الأسطر - مفرد. يوصى بفصل الكتل الدلالية بأسطر فارغة ، وكذلك لوضع علامات مرئية على التركيبات المتداخلة مع المسافات البادئة.

11.5 الكلمات الرئيسية والتعليقات في قائمة البرنامج يمكن أن تكون مائلة. في النص الرئيسي لـ PP ، يجب استخدام الخط المائل لإبراز أسماء المكتبات والروتينات الفرعية والثوابت والمتغيرات وما إلى ذلك.

11.6 يجب ترقيم قوائم البرامج بشكل تسلسلي داخل التطبيق. يجب أن يتكون رقم القائمة من تسمية التطبيق والرقم التسلسلي للقائمة ، مفصولاً بنقطة ، على سبيل المثال: "القائمة أ .3" - القائمة الثالثة من الملحق أ. إذا كان المشروع (العمل) يحتوي على قائمة واحدة فقط ، فهو المعينة "القائمة 1". عند الإشارة إلى قائمة في نص PP ، يجب كتابة كلمة "قائمة" مع الإشارة إلى رقمها.

11.7 يتم وضع اسم قائمة البرنامج بنفس خط النص الرئيسي ، ويتم وضعه فوق القائمة الموجودة على اليسار ، بدون مسافة بادئة للفقرة ، من خلال شرطة ، بعد رقم القائمة.

مثال على قائمة برنامج سرد أ .3 - برنامج "إخراج مصفوفة ثنائية الأبعاد"

ماس: مجموعة عدد صحيح ؛ ( إعلان مصفوفة ثنائية الأبعاد) ط ، ي: عدد صحيح ؛

قواعد ومتطلبات التسجيل لمحتوى مشاريع الدورة (الأعمال) وأعمال التأهيل النهائية - 09.1

(إدخال قيم عناصر المصفوفة) لـ i: = 1 إلى 5 do

بالنسبة إلى j: = 1 إلى 5 do readln (mas) ؛

(عرض قيم عناصر المصفوفة) لـ i: = 1 إلى 5 تبدأ

بالنسبة إلى j: = 1 إلى 5 اكتب (""، mas) ؛ ريتيلن.

12 تحكم نورم

12.1 التحكم المعياري هو المرحلة النهائية في تطوير الوثائق لمشروع الدورة التدريبية (العمل) و WRC.

12.2 يجب أن يتوافق التحكم المعياري مع متطلبات GOST 2.111.

12.3 تخضع أعمال التأهيل النهائي للرقابة المعيارية. يتم تنفيذ التحكم القياسي في مشاريع الدورة التدريبية من قبل المعلم عند الدفاع عن العمل. يهدف إجراء التحكم القياسي إلى التنفيذ الصحيح للوثائق النصية والرسومات لمشاريع الدورة التدريبية (الأعمال) و WQP (المشار إليها فيما يلي بالوثائق) وفقًا لمتطلبات معايير GOST و ESKD و ESPD و ESTD.

12.4 يتم الامتثال من قبل المفتش التنظيمي ، مع مراعاة متطلبات المعايير الحالية والوثائق المعيارية والفنية.

12.5 في عملية التحكم القياسي في الملاحظات التفسيرية لمشروعات الدورة التدريبية (الأعمال) و WRC ، يتم التحقق مما يلي:

- الامتثال لقواعد التسجيل وفقًا لهذه اللائحة ؛

- مظهر PZ ؛

- اكتمال PP وفقًا لتخصيص التصميم ؛

- صحة ملء صفحة العنوان ، ووجود التوقيعات اللازمة ؛

- صحة ملء بيان المشروع (العمل) ؛

- وجود الإطارات والنقوش الرئيسية في جميع الصفحات وصحتها ؛

- إبراز العناوين والأقسام والأقسام الفرعية ، ووجود خطوط حمراء ؛

- التنسيق الصحيح للمحتوى ، وتطابق عناوين الأقسام والأقسام الفرعية في المحتوى مع الأسماء المقابلة في نص الملاحظة ؛

- الترقيم الصحيح للصفحات والأقسام والأقسام الفرعية والأشكال والجداول والصيغ ؛

- صحة الرسم ؛

- صحة الجداول.

- صحة أبعاد الكميات الفيزيائية وامتثالها للنظام الدولي للوحدات ؛

- الامتثال لمعايير اللغة الروسية الحديثة ؛

- صحة اختصارات الكلمة المطبقة ؛

قواعد ومتطلبات التسجيل لمحتوى مشاريع الدورة (الأعمال) وأعمال التأهيل النهائية - 09.1

توافر وصحة المراجع إلى المصادر المستخدمة ؛

توافر وصحة المراجع إلى الوثائق التنظيمية ؛

صحة قائمة المصادر المستخدمة ؛

التصميم الصحيح للتطبيقات.

12.6 في عملية التحكم القياسي في المستندات الرسومية لمشاريع الدورات الدراسية (الأعمال) و WRC ، يتم التحقق مما يلي:

الامتثال لتصميم الرسم مع متطلبات المعايير المعمول بها ؛

تنفيذ الرسومات وفقًا لمتطلبات المستندات التنظيمية ؛

الامتثال للصيغ وصحة تصميمها ؛

صحة المخطط وتطبيق الخطوط ؛

مراعاة المقاييس وصحة تعيينها ؛

كفاية الصور (الأنواع ، الأقسام ، الأقسام) ، صحة تسميتها وموقعها ؛

الامتثال لرموز العناصر في المخططات وقواعد تنفيذها وفقًا لمتطلبات ESKD.

12.7. يوصى بإجراء رقابة قياسية على أعمال التأهيل النهائية على مرحلتين: بعد التقريبي (أو في خطوط رفيعة) والتطوير النهائي للوثائق الأصلية. يجب تقديم المستندات قيد التطوير للرقابة المعيارية في مجموعة كاملة ، أي نص (ملاحظة توضيحية) ووثائق رسومية (رسومات ، مواصفات ، إلخ).

12.8 يتم وضع قائمة ملاحظات المشرف في حالة تنفيذ الرقابة في غياب المطور الطالب وقد يساء تفسير جوهر الأخطاء من قبله.

12.9 يتم إعادة المستندات التي تم فحصها بواسطة المراقب المعياري في وجود مطور الطالب ، جنبًا إلى جنب مع قائمة التعليقات (إذا تم وضعها) ، إلى الطالب للتصحيح والمراجعة. في حالة وجود تعليقات ، يتم حفظ ملاحظات المفتش حتى يوقع المستند. إذا تمت إعادة معالجة المستند من قبل الطالب ، فسيتم إرسال كلتا النسختين لإعادة التحكم: بعلامات المشرف ومراجعتها.

12.10 يجب أن تحتوي المستندات المقدمة للتوقيع على المفتش التنظيمي على جميع تأشيرات الموافقة ، باستثناء تأشيرة رئيس القسم. يتم توقيع الأصول النظيفة لمشاريع (أعمال) الفصل الدراسي والدبلوم من قبل المراقب

الخامس العمود "N.contr." كتلة العنوان.

12.11 يحظر التقديم دون علم المشرفأي تغييرات على الوثيقة بعد توقيع هذه الوثيقة والمصادقة عليها من قبل المفتش التنظيمي.

12.12 يحق للمراقب ، في الحالات المبررة ، عدم التوقيع على المستند المقدم:

- في حالة عدم الامتثال لمتطلبات الوثائق التنظيمية ؛

- في حالة عدم وجود توقيعات إلزامية ؛

- في حالة الإعدام بإهمال ؛

- في حالة مخالفة ثبوت الاكتمال.

قواعد ومتطلبات التسجيل لمحتوى مشاريع الدورة (الأعمال) وأعمال التأهيل النهائية - 09.1

12.13 المراقب القياسي مسؤول عن الامتثال لمتطلبات المعايير الحالية والوثائق المعيارية والتقنية الأخرى في الوثائق المطورة على قدم المساواة مع مطوري الوثائق.

13 استعراض المؤتمر العالمي للاتصالات الراديوية

13.1 للحصول على تقييم موضوعي إضافي لعمل التأهيل النهائي المقدم للدفاع ، يتم إجراء مراجعة خارجية لأعمال التأهيل النهائي من قبل متخصصين في المجال ذي الصلة.

13.2 مراجعو الأعمال المؤهلة النهائية متخصصون مؤهلون تأهيلاً عالياً ، ويتم تحديد قائمتهم الشخصية من قبل إدارة الإصدار. كمراجعين يمكن أن تشاركالممارسين والمعلمين من الجامعات الأخرى.

يتم إصدار إحالة للمراجعة من قبل إدارة الإصدار ، ويتم تقديم شكلها في الملحق T من هذه القواعد.

13.3 يجب أن يكون المراجع على دراية بجميع متطلبات العمل المؤهل النهائي (WQ).

13.4 تمت المراجعة كتابيًا وتحتوي على تقييمات منطقية:

- أهمية موضوع المؤتمر العالمي للاتصالات الراديوية ؛

- الامتثال لمحتوى FQP مع مهمة تطويرها ؛

- صحة الهيكل المنطقي للمؤتمر العالمي للاتصالات الراديوية ؛

- كفاءة وصلاحية حلول التصميم ؛

- مزايا وعيوب FQP ، امتثالها لمتطلبات التأهيل للخريجين في مجال التدريب ؛

- تسجيل FQP.

في الجزء الأخير من المراجعة ، تم تقديم استنتاجات حول اكتمال تطوير الموضوع ، وفقًا للمهام المحددة ، والأهمية النظرية أو العملية للمؤتمر العالمي للاتصالات الراديوية ، وحول المجال المحتمل لاستخدام نتائج المؤتمر العالمي للاتصالات الراديوية. يقوم المراجع بتقييم العمل على مقياس من أربع نقاط ("ممتاز" ، "جيد" ، "مرض" ، "غير مرض") ويشير إلى إمكانية تخصيص المؤهلات المناسبة للطالب.

13.5 يجب أن يكون حجم المراجعة للعمل التأهيلي النهائي 2-3 صفحات من النص المطبوع أو المكتوب بخط اليد بوضوح. يجب تقديم المراجعة الموقعة إلى الإدارة في موعد لا يتجاوز ثلاثة أيام قبل دفاع FQP.

13.6 يمكن إجراء المراجعة على ترويسة المنظمة (مكان عمل المراجع) ، أو على ورق ذي رأسية للنموذج الذي تم إنشاؤه ، والذي تنظمه هذه القواعد (الملحق U) وموثق بختم المنظمة ، أو بختم قسم شؤون الموظفين (الإدارة العامة ، المكتب) بعلامة "التوقيع صحيح".

13.7 للدفاع عن FQP ، يمكن للجنة إصدار الشهادات الحكومية أيضًا تقديم مراجعة للمنظمة الرائدة ، بأمر منها

قواعد ومتطلبات التسجيل لمحتوى مشاريع الدورة (الأعمال) وأعمال التأهيل النهائية - 09.1

تم تنفيذ WRC. يجب أن تشير التعليقات إلى القيمة العملية للنتائج التي تم الحصول عليها.

14 تعليقات على المؤتمر العالمي للاتصالات الراديوية

14.1 يتم وضع التعليقات على العمل المؤهل النهائي مباشرة من قبل رئيسها. يجب أن تميز المراجعة FQP من جوانب مختلفة: من جانب المحتوى ، والهيكل ، واكتمال الكشف عن الموضوع المحدد ، وما إلى ذلك.

14.2 يجب على القائد أن يذكر في المراجعة رأيه الموضوعي في العمل المؤهل النهائي للطالب. على وجه الخصوص ، يجب أن تحتوي المراجعة على معلومات:

- حول أهمية موضوع العمل ؛

- بشأن امتثال أعمال التأهيل النهائية لمتطلبات المعايير ؛

- على حيازة الطالب لأساليب جمع ومعالجة وتحليل المعلومات المستخدمة في مجال النشاط المهني ؛

- حول قدرة الطالب على العمل بشكل مستقل مع المصادر لتقديم المواد بشكل واضح وواضح ومتسق ؛

- حول الجوانب الإيجابية للعمل ؛

- حول أوجه القصور والتعليقات على محتوى العمل ، إلخ.

14.3 قد تحتوي مراجعة العمل المؤهل النهائي للمشرف على مقترحات لتقييم عام للعمل.

14.4 في ختام المراجعة ، يخلص الرئيس إلى أنه من الممكن تقديم العمل المؤهل النهائي للدفاع إلى الدفاع في SJSC.

14.5 تتم طباعة نص رد المشرف على FQP على أوراق A4 وتوقيعه من قبل المشرف. ويرد شكل التعليقات على المؤتمر العالمي للاتصالات الراديوية في الملحق "و".

15 التقرير والعرض

15.1 التقرير (الكلام) هو عرض تقديمي يعكس جوهر المؤتمر العالمي للاتصالات الراديوية.

في التقرير ، من الضروري التطرق إلى أهمية الموضوع المختار ، والأسس النظرية والمنهجية للعمل ، وكذلك تلخيص وتلخيص النتائج التي تم الحصول عليها في سياق البحث.

في نهاية العرض ، من الضروري أن تعكس الأهمية العملية للنتائج ، وإمكانية تنفيذها في الممارسة أو استخدامها في التدريس.

15.2 تم تصميم التقرير لفترة محدودة من العرض ويرتبط ارتباطًا وثيقًا بالعرض التقديمي (النشرات).

قواعد ومتطلبات التسجيل لمحتوى مشاريع الدورة (الأعمال) وأعمال التأهيل النهائية - 09.1

15.3 العرض التقديمي (النشرات) عبارة عن مادة مرئية رقمية وجدولية وتوضيحية يتم إعدادها بمساعدة برامج خاصة (على سبيل المثال ، Microsoft PowerPoint) ، والتي ترتبط ارتباطًا مباشرًا بالتقرير.

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

يجب أن توضح المادة جميع الأطروحات المشتقة في التقرير.

15.5 يمكن عرض العرض بطريقتين:

بمساعدة جهاز عرض وعلى المنصة ؛

استخدام النشرات على شكل نسخ ورقية لكل عضو من أعضاء الهيئة.

يمكن أن يكون حجم العرض من 8 إلى 12 شريحة.

15.6 يجب أن يحتوي التقرير فقط على جوهر القضية قيد النظر ، حد أدنى من البيانات الرقمية والأسماء الخاصة وعمليات النقل.

تم تنظيم التقرير وفقًا لنفس المخطط المنطقي مثل المشروع (العمل) ، أي: الجزء التمهيدي والجزء الرئيسي والاستنتاجات. يجب أن يحتوي الجزء التمهيدي على أهمية العمل والغرض منه ، ويجب أن يكشف الجزء الرئيسي بشكل كامل عن الموضوع قيد النظر. يجب أن تكون الاستنتاجات موجزة ولا لبس فيها ، و

في جملة أو اثنتين ، ضع في اعتبارك التوصيات لحل المشكلات المطروحة.

15.7 يجب أن تكون الأولى شريحة مع موضوع المشروع (العمل) وبيانات المؤدي ، أي: اللقب ، الاسم ، اسم الأب ، المجموعة ، التخصص (الاتجاه). من المستحسن الإشارة إلى مستشار علمي.

15.8 يتم تسليم مشروع الدورة التدريبية (العمل) و FQP إلى الأرشيف جنبًا إلى جنب مع عرض تقديمي يتم تقديمه في شكل إلكتروني ويتم تسجيله على وسيط رقمي (على سبيل المثال ، قرص مضغوط / قرص DVD).

قواعد ومتطلبات التسجيل لمحتوى مشاريع الدورة (الأعمال) وأعمال التأهيل النهائية - 09.1

الملحق أ

قواعد ومتطلبات التسجيل لمحتوى مشاريع الدورة (الأعمال) وأعمال التأهيل النهائية - 09.1

ملحق ب

(اسم الكلية)

(اسم القسم)

____________ ________________

ملاحظة توضيحية

إلى مشروع الدورة (عمل) في التخصص (وحدة) __

(اسم التخصص الأكاديمي (وحدة))

حول الموضوع _________________________________________________________________________________

_____

_______________________

______________________________

الاتجاه / التخصص ، الملف الشخصي / التخصص:

___________ _________________________________________________________________

اسم رمز الاتجاه للاتجاه (تخصص)

________________________________________________________________________________

اسم الملف الشخصي (التخصص)

تعيين مشروع الدورة (العمل) _________________________ مجموعة ________

روستوف اون دون

ملحق ب

وزارة التعليم والعلوم في الاتحاد الروسي

المؤسسة التعليمية لميزانية الدولة الفيدرالية للتعليم المهني العالي

"جامعة دون ستيت التقنية" (DSTU)

الأساتذه _______________________________________________________

(اسم الكلية)

قسم _________________________________________________________

(اسم القسم)

رئيس قسم "______________"

____________ ________________

ملاحظة توضيحية

لمشروع أطروحة (عمل) حول الموضوع:

___________________________________________________________________________

___________________________________________________________________________

___________________________________________________________________________

__________________________

(تاريخ التوقيع)

تعيين مشروع الدبلوم ______________________

مجموعة ______________

الاتجاه (التخصص) ___________

___________________________________

(اسم)

مدير مشروع (عمل)

____________________________

(تاريخ التوقيع)

(المنصب ، I.O.F.)

مستشارو القسم:

_______________________________

_____________________

(اسم القسم)

(تاريخ التوقيع)

(المنصب ، I.O.F.)

_______________________________

_____________________

(اسم القسم)

(تاريخ التوقيع)

(المنصب ، I.O.F.)

تحكم نورم

_____________________

(تاريخ التوقيع)

(المنصب ، I.O.F.)

روستوف اون دون

قواعد ومتطلبات التسجيل لمحتوى مشاريع الدورة (الأعمال) وأعمال التأهيل النهائية - 09.1

يتم إعداد برامج الحاسب الآلي وفقًا لمتطلبات النظام الموحد لتوثيق البرمجة (ESPD). ESPD - مجموعة من GOSTs التي تحدد قواعد التصميم والمحتوى وهيكل مستندات البرنامج.
يحتوي هذا الكيفية على مقتطفات من ESPD. يمكن الحصول على معلومات كاملة مباشرة من GOSTs.

خوارزمية موجزة لتصميم البرنامج

باختصار ، يتم عرض خوارزمية تصميم البرنامج وأنواع وثائق البرنامج في الشكل. يتم وصف عملية التسجيل بمزيد من التفاصيل أدناه.

تسجيل وثيقة البرنامج

وثيقة البرنامج - وثيقة تحتوي على المعلومات اللازمة لتطوير وتصنيع وصيانة وتشغيل البرامج.

يتم إعداد كل مستند برنامج فردي وفقًا (المشترك لجميع مستندات ESPD) لمتطلبات GOST 19.101-77 ، GOST 19.103-77 ، GOST 19.104-78 ، GOST 19.105-78 ، GOST 19.106-78 ، GOST 19.604-78 ( فيما يلي وصف أكثر تفصيلاً لهذه GOST) و GOST لوثيقة برنامج محددة.

المتطلبات العامة لوثائق البرنامج. GOST 19.105 - 78

متطلبات وثائق البرنامج المطبوعة. GOST 19.106 - 78

يحدد GOST 19.106-78 قواعد تنفيذ مستندات البرنامج لطريقة التنفيذ المطبوعة.

من المهم ملاحظة أن GOST هذا لا ينطبق على وثيقة البرنامج "نص البرنامج".

مواد وثيقة البرنامج يجب أن يكون بالتسلسل التالي:

  • جزء العنوان:
    • ورقة الموافقة (غير مدرجة في العدد الإجمالي لأوراق الوثيقة) ؛
    • صفحة العنوان (الصفحة الأولى من المستند) ؛
  • الجزء الإعلامي:
    • حاشية. ملاحظة؛
    • ورقة المحتوى
  • الجزء الرئيسي:
    • نص المستند (بالصور والجداول وما إلى ذلك) ؛
    • التطبيقات ؛
    • قائمة المصطلحات ، قائمة الاختصارات ، قائمة الأشكال ، قائمة الجداول ، فهرس الموضوع ، قائمة الوثائق المرجعية ؛
    • جزء من تسجيل التغييرات:
    • تغيير ورقة التسجيل.

يشير التعليق التوضيحي إلى إصدار البرنامج ، ويصف بإيجاز الغرض من المستند ومحتواه. إذا كان المستند يتكون من عدة أجزاء ، فيتم توضيح العدد الإجمالي للأجزاء في التعليق التوضيحي. يتم وضع محتوى المستند في صفحة (صفحات) منفصلة (مرقمة) بعد التعليق التوضيحي ، مع توفير العنوان "CONTENT" ، وليس مرقمًا كقسم ويتم تضمينه في العدد الإجمالي لصفحات المستند.

تنسيق النص:

  • يتم تنفيذ وثيقة البرنامج على جانب واحد من الورقة ، على فترتين ؛ مسموح به على فاصل زمني واحد أو واحد ونصف.
  • يتم وضع التعليق التوضيحي في صفحة منفصلة (مرقمة) بالعنوان "ANNOTATION" ولا يتم ترقيمها كقسم.
  • تتم كتابة عناوين الأقسام بأحرف كبيرة ويتم وضعها بشكل متماثل بالنسبة إلى الحدود اليمنى واليسرى للنص.
  • تتم كتابة عناوين الأقسام الفرعية مع فقرة بأحرف صغيرة (باستثناء الأحرف الكبيرة الأولى).
  • لا يُسمح باستخدام الواصلة في العناوين. لا تضع نقطة في نهاية العنوان.
  • يجب أن تكون المسافة بين العنوان والنص التالي ، وكذلك بين عناوين القسم والأقسام الفرعية ، مساوية لـ:
    • عند تنفيذ المستند بطريقة مطبوعة - فترتان.
  • بالنسبة للأقسام والأقسام الفرعية ، التي يكون نصها مكتوبًا على نفس الصفحة مع نص القسم السابق ، يجب أن تكون المسافة بين آخر سطر من النص والعنوان التالي مساوية:
    • عند تنفيذ مستند بالطريقة الكاتبة - ثلاث فواصل زمنية مطبوعة.
  • يجب ترقيم الأقسام والأقسام الفرعية والبنود والفقرات بالأرقام العربية مع نقطة.
  • يجب أن يكون هناك ترقيم مستمر داخل القسم لجميع الأقسام الفرعية والبنود والبنود الفرعية المدرجة في هذا القسم.
  • يتضمن ترقيم الأقسام الفرعية رقم القسم والرقم الترتيبي للقسم الفرعي المتضمن في هذا القسم ، مفصولة بنقطة (2.1 ؛ 3.1 ، إلخ).
  • في حالة وجود أقسام وأقسام فرعية ، تتم إضافة الرقم التسلسلي للفقرة والفقرة الفرعية (3.1.1 ، 3.1.1.1 ، إلخ) إلى رقم القسم الفرعي بعد النقطة.
  • يجب أن يكون نص الوثيقة قصيرًا وواضحًا ويستبعد احتمال سوء التفسير.
  • يجب أن تكون المصطلحات والتعريفات موحدة ومتوافقة مع المعايير المعمول بها ، وفي حالة عدم وجودها - مقبولة بشكل عام في الأدبيات العلمية والتقنية ، ويجب تقديمها في قائمة المصطلحات.
  • يمكن صياغة التفسيرات اللازمة لنص الوثيقة مع الحواشي السفلية.
  • يتم الإشارة إلى الحاشية السفلية برقم مع وضع قوس على مستوى الحافة العلوية للخط ، على سبيل المثال: "printing device2) ..." أو "paper5)".
  • إذا كانت الحاشية تشير إلى كلمة منفصلة ، يتم وضع علامة الحاشية السفلية بجوار هذه الكلمة مباشرة ، ولكن إذا كانت تشير إلى الجملة بأكملها ، فعندئذٍ في نهاية الجملة. يتم وضع نص الحاشية السفلية في نهاية الصفحة ويتم فصله عن النص الرئيسي بخط 3 سم مرسوم على الجانب الأيسر من الصفحة.
  • الرسوم التوضيحية ، إذا كان هناك أكثر من واحدة في هذا المستند ، يتم ترقيمها بالأرقام العربية في جميع أنحاء المستند.
  • يتم ترقيم الصيغ في المستند ، إذا كان هناك أكثر من واحد ، بالأرقام العربية ، ويتم وضع الرقم على الجانب الأيمن من الصفحة ، بين قوسين على مستوى الصيغة.
  • يجب إعطاء معنى الرموز والمعاملات العددية المضمنة في الصيغة مباشرة أسفل الصيغة. تتم طباعة معنى كل حرف على سطر جديد بالترتيب الذي وردت به في الصيغة. يجب أن يبدأ السطر الأول من فك التشفير بكلمة "حيث" ، بدون نقطتين بعدها.
  • يُسمح بالإشارات إلى المعايير (باستثناء معايير المؤسسة) والمواصفات الفنية والوثائق الأخرى (على سبيل المثال ، وثائق هيئات الإشراف الحكومية ، وقواعد ومعايير اتحاد الجمهوريات الاشتراكية السوفياتية Gosstroy) في وثائق البرنامج. عند الإشارة إلى المعايير والمواصفات ، وضح تسميتها.
  • يجب الإشارة إلى الوثيقة ككل أو إلى أقسامها (مع الإشارة إلى تسمية وعنوان الوثيقة ورقم وعنوان القسم أو التطبيق). عند إعادة الإشارة إلى قسم أو ملحق ، يشار فقط إلى الرقم.
  • في الملاحظات على النص والجداول ، يشار فقط إلى البيانات المرجعية والتفسيرية.
  • ملاحظة واحدة غير مرقمة. بعد كلمة "ملاحظة" ضع نقطة.
  • يجب ترقيم العديد من الملاحظات بأرقام عربية متسلسلة مع نقطة. يتم استخدام النقطتين بعد كلمة "ملاحظة".
  • لا يُسمح باختصارات الكلمات في النص والتعليقات التوضيحية أسفل الرسوم التوضيحية.
  • يجوز إصدار مواد أو جداول أو نص إضافي مصور في شكل مرفقات.
  • يجب أن يبدأ كل ملحق في صفحة جديدة مع الإشارة إلى كلمة "ملحق" في الزاوية اليمنى العليا وأن يكون له عنوان موضوعي مكتوب بشكل متماثل مع النص بأحرف كبيرة.

يوجد في GOST ورقة عينة ، حيث يشار إلى الحقول وأماكن ترقيم الصفحات والتشفير.