3.3.5. Частина реєстрації змін

Про кожну зміну програмного документа робиться запис відповідно до вимог ГОСТ 19.603-78.

3.4. Опис програми (гост 19.402-78)

Встановлюються склад і вимоги до змісту програмного документа «Опис програми», визначеного ГОСТ 19.101-78.

«Опис програми» – основний документ, який представляє ПЗ, призначений для користувачів, замовника, програміста і т.д. Тут повинні бути надані всі відомості про програму, які можуть бути потрібні під час її супроводу і експлуатації.

Структура і оформлення документа встановлюються відповідно до ГОСТ 19.105-78.

Опис програми - головний документ у якому повинні бути відображені усі складові проекту (наприклад у Rational Rose) та його реалізації.

3.4.1. Загальні положення

3.4.1.1. Складання інформаційної частини (анотація і зміст) є обов'язковим.

3.4.1.2. Опис програми повинен містити такі розділи:

– загальні відомості;

– функціональне призначення;

– опис логічної структури;

– використані технічні засоби;

– виклик і завантаження;

– вхідні дані;

– вихідні дані.

Залежно від особливостей програми допускається вводити додаткові розділи або об'єднувати окремі розділи.

3.4.1.3. Рекомендується включати розділи: опис призначеного для користувача інтерфейсу і порядку роботи з програмою, повідомлення, що видаються.

3.4.2. Зміст розділів

3.4.2.1. У розділі «Загальні відомості» повинні бути вказані:

– позначення і найменування програми;

– програмне забезпечення, необхідне для функціонування програми;

– мови програмування, на яких написана програма.

3.4.2.2. У розділі «Функціональне призначення» повинні бути вказані класи вирішуваних задач і (або) призначення програми і відомості про функціональні обмеження на застосування.

3.4.2.3. У розділі «Опис логічної структури» повинні бути вказані:

– алгоритм програми;

– використані методи;

– структура програми з описом функцій складових частин і зв'язки між ними;

– зв'язки програми з іншими програмами.

Опис логічної структури програми виконують з урахуванням тексту програми на початковій мові.

3.4.2.4. У розділі «Використані технічні засоби» повинні бути вказані типи електронних обчислювальних машин і пристроїв, які використовуються у роботі програми.

3.4.2.5. У розділі «Виклик і завантаження» повинні бути вказані:

– спосіб виклику програми з відповідного носія даних;

– вхідні точки в програму.

Допускається указувати адреси завантаження, відомості про використання оперативної пам'яті, об'єм програми.

3.4.2.6. У розділі «Вхідні дані» повинні бути вказані:

– характер, організація і попередня підготовка вхідних даних;

– формат, опис і спосіб кодування вхідних даних.

3.4.2.7. У розділі «Вихідні дані» повинні бути вказані:

– характер і організація вихідних даних;

– формат, опис і спосіб кодування вихідних даних.

3.4.2.8. У розділі «Опис призначеного для користувача інтерфейсу» слід представити:

– мережу переходів, таблицю станів або розгорнуту систему меню;

– опис кожного стану і можливостей роботи з ним;

– опис керування діалогом;

– форматування екрану.

3.4.2.9. У розділі «Порядок роботи з програмою» необхідно описувати технологію роботи з програмою і порядок виконання самої програми.

1. Прийом інформації факсом (оператор) 8.00 – 13.00

2. Введення інформації (оператор) 13.00 – 14.00

3. Розрахунок плану наступного дня (інженер-технолог) 14.30

4. Узгодження плану (начальник цеху)

Тут слід описати весь технологічний ланцюжок із зазначенням термінів, виконавців, програмних і технічних засобів.

3.4.2.10. У розділі «Повідомлення» слід навести всі повідомлення про нештатні ситуації в такому вигляді:

– текст повідомлення;

– для кого призначено (оператора, користувача, програміста або ін.);

– опис ситуації;

– рекомендовані дії.

3.4.2.11. Допускається зміст розділів ілюструвати прикладами пояснень, таблицями, схемами, графіками.

3.4.2.12. У додаток до опису програми допускається включати різні матеріали, які недоцільно включати в розділи опису.