- •Міністерство транспорту та зв’язку україни
- •Дніпропетровський національний університет залізничного транспорту імені академіка в. Лазаряна
- •Основи стандартизації програмних систем
- •Лабораторна робота № 1
- •Стадії та етапи розробки
- •3.2. Вимоги до складу програмних документів
- •3.2.1. Види програмних документів (гост 19.101-77)
- •Види програмних документів
- •Види експлуатаційних документів
- •3.3. Вимоги до оформлення програмної документації
- •3.3.1. Оформлення титульної частини програмного документа
- •3.3.1.1. Основні написи листа затвердження (лз)
- •Коди документів
- •1116130.00001-01-Лз,
- •3.3.1.2. Основні написи титульного листа
- •3.3.2. Оформлення інформаційної частини програмного документа
- •3.3.3. Оформлення основної частини програмного продукту
- •3.3.3.1. Текст документа
- •3.3.3.2. Ілюстраціі
- •3.3.3.3. Формули
- •3.3.3.4. Посилання
- •3.3.3.5. Таблиці
- •3.3.3.6. Примітки
- •3.3.3.7. Додатки
- •3.3.3.8. Оформлення частини реєстрації змін програмного документа
- •3.4. Вимоги до змісту документації (Технічне завдання (гост 19.201-78))
- •3.4.1. Зміст розділів
- •Лабораторна робота № 2
- •3.1.2. Зміст розділів
- •3.2. Специфікація (гост 19.202-78)
- •3.2.1. Загальні положення
- •3.2.2. Зміст розділів
- •Приклад специфікації
- •3.3. Текст програми (гост 19.401-78)
- •3.3.5. Частина реєстрації змін
- •3.4. Опис програми (гост 19.402-78)
- •3.4.1. Загальні положення
- •3.4.2. Зміст розділів
- •3.5. Опис застосування (гост 19.502-78)
- •3.5.1. Загальні положення
- •3.5.2. Зміст розділів
- •3.6. Керівництво оператора (гост 19.505-79)
- •3.6.1. Загальні положення
- •3.6.2. Зміст розділів
- •3.7. Керівництво програміста (гост 19.504-79)
- •3.7.1. Загальні положення
- •3.7.2. Зміст розділів
- •3.8. Керівництво системного програміста (гост 19.503-79)
- •3.8.1. Загальні положення
- •3.8.2. Зміст розділів
- •3.9. Керівництво користувача (рд 50-34.698-90) [6]
- •3.10. Вимоги до змісту і оформлення записки пояснення до дипломного проекту
- •Лабораторна робота № 3
- •49010, Дніпропетровськ, вул. Лазаряна, 2; www.Diitrvv.Dp.Ua.
3.7. Керівництво програміста (гост 19.504-79)
Встановлюються вимоги до змісту і оформлення програмного документа «Керівництво програміста», визначеного ГОСТ 19.101-77.
Документ розробляється у випадках:
– передбачуваного початкового налагодження ПЗ з урахуванням конкретних умов експлуатації, пов'язаного із зміною деяких файлів і/або програм;
– наявність пропонованих змін у програмі за нештатних ситуацій.
3.7.1. Загальні положення
3.7.1.1. Структура і оформлення документа встановлюється відповідно до ГОСТ 19.105-78.
Складання інформаційної частини (анотації і зміст) є обов'язковим.
3.7.1.2. Керівництво програміста повинно містити такі розділи:
– призначення і умови застосування програми;
– характеристики програми;
– звернення до програми;
– вхідні і вихідні дані;
– повідомлення.
Залежно від особливостей документа допускається об'єднувати окремі розділи або додавати нові.
3.7.2. Зміст розділів
3.7.2.1. У розділі «Призначення і умови застосування програми» повинні бути вказані призначення і функції, що виконуються програмою, умови, необхідні для виконання програми (об'єм оперативної пам'яті, вимоги до складу і параметрів периферійних пристроїв, вимоги до програмного забезпечення і т. п.).
3.7.2.2. У розділі «Характеристики програми» повинен бути наведений опис основних характеристик і особливостей програми (тимчасові характеристики, режим роботи, засоби контролю правильності виконання і самовідновлюваності програми і т.п.).
3.7.2.3. У розділі «Звернення до програми» повинен бути наведений опис процедур виклику програми (способи передачі керування і параметрів, даних і ін.).
3.7.2.4. У розділі «Вхідні і вихідні дані» повинен бути наведений опис організації використаної вхідної і вихідної інформації і, якщо необхідно, її кодування.
3.7.2.5. У розділі «Повідомлення» повинні бути вказані тексти повідомлень, що видаються програмістові або операторові в ході виконання програми, опис їх змісту і дії, які необхідно зробити за цими повідомленнями.
Необхідно навести всі повідомлення програми у вигляді:
– текста повідомлення;
– опису ситуації;
– дій користувача, оператора і т. д.
3.7.2.6. У додатку до керівництва програміста можуть бути наведені додаткові матеріали (приклади, ілюстрації, таблиці, графіки і т. п.).
3.7.2.7. Необхідно пам'ятати, що це інструкція. У разі початкового налагодження ПЗ, повинен бути включений розділ, в якому регламентуються дії програміста. Наприклад:
– у випадку … змінити константи … у модулі …;
– відкомпілювати модулі …;
– редактором зв'язків виконати збірку модулів … ;
– у директорію … помістити модуль … ,
тобто опис конкретних дій, їх порядок і на підставі чого вони повинні виконуватися.
3.8. Керівництво системного програміста (гост 19.503-79)
Документ розробляється у випадках:
– необхідності початкового налагодження операційної системи (ОС) або оболонок, що потрібно для функціонування даного ПЗ;
– необхідності зміни яких-небудь параметрів ОС у нештатних ситуаціях;
– якщо є машинозалежна або залежна від версії ОС частина програми. Наприклад, замінюються стандартні обробники переривань, завантажуються резидентні програми і т. п. При цьому системний програміст повинен бути поінформований про можливі наслідки для виконання інших програм після даної.