Опис програми

Документ Опис програми регламентується ЄСПД ГОСТ 19.402-78, код - 13.

Основна частина документа складається із вступу й наступних розділів:

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

- опис логічної структури,

- умови застосування;

- вхідні та вихідні дані;

- склад і функції;

- виклик і завантаження.

У вступній частині документа подається інформація загального характеру про програму: повна назва, позначення, її можливі застосування.

Наприклад: Програма «Інформаційно-пошукова система» призначена для робітників служби …, може використовуватися в установах …, реалізована на мові програмування ….

У розділі “Функціональне призначення” вказують призначення програми й приводять загальний опис функціонування програми, її основні характеристики.

Наприклад: Програма призначена для вирішення завдань пошуку... Програма використовується самостійно (не вимагає інших програм). Користувач має можливість знайти..., відредагувати дані про …(додати, видалити, змінити вже існуючі), переглянути дані про ….

У розділі “Опис логічної структури” вказують:

· опис структури програми та її основних частин.

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

· відомості про мову програмування;

· опис вхідних і вихідних даних для кожної зі складових частин;

· опис логіки складових частин.

При описі структури програми та її основних частин можна вказати, наприклад, таке:

До складу програми входять наступні модулі:

- інтерфейсний,

- базового класу CBazeClass,

- класу спадкоємця CAvto,

- класу - колекції CAvtoServise.

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

Програма складається із чотирьох модулів: інтерфейсного та модулів класів. Інтерфейс побудований на діалозі типу "меню". Інтерфейсний модуль управляє взаємодією.... Модуль базового класу BazeClass містить опис... Він є базовим в ієрархії класів... і т.д.

Коли подаються відомості про мову програмування можна вказати таке, наприклад:

Програма написана мовою... з використанням компілятора....

При опису вхідних і вихідних даних для кожної зі складових частин вказують, наприклад:

Вхідними даними для функції читання даних з файлу є текстовий файл, що містить дані про …. Вихідними даними є

- двонаправлений список з головним та хвостовими елементами.

При опису логіки складових частин варто навести опис схеми програми. При описі логіки програми необхідна прив'язка до тексту програми.

У розділі “Умови застосування” вказуються умови, які необхідні для виконання програми, наприклад:

Програма експлуатується на IBM-сумісних ПК під управлінням ОС Windows 2000/XP/2003/Vista. Для роботи в діалоговому режимі використається екран монітора, клавіатура та маніпулятор типу "миша". Вхідні дані зберігаються на зовнішніх носіях CD-R/RW, FLASH-RAM або HDD.

У розділі “Вхідні та вихідні дані” вказують, наприклад:

Вхідними даними для програми є текстовий файл, що містить дані про …. Вихідними даними є:

- виведена на екран текстова інформація про …;

- текстовий файл – результат редагування даних.

У розділі “Склад і функції” вказують опис складу й функції програми, застосовуваних методів рішення завдань.

У розділі “Виклик й завантаження” можна вказати, наприклад, таке:

Завантаження програми здійснюється набором у командному рядку DOS імені завантажувального файлу - INFO.EXE з можливою вказівкою імені файлу даних.