Документ Опис програми регламентується ЄСПД ГОСТ 19.402-78 [7], код - 13.
Основна частина документа складається із вступу й таких розділів:
– функціональне призначення;
– опис логічної структури,
– умови застосування;
– вхідні та вихідні дані;
– склад і функції;
– виклик і завантаження.
У вступній частині документа подається інформація загального характеру про програму: повна назва, позначення, її можливі застосування.
Наприклад: Програма «Інформаційно-пошукова система» призначена для робітників служби … , може використовуватися в установах …, реалізована на мові програмування … .
У розділі «Функціональне призначення» вказують призначення програми й наводять загальний опис функціонування програми, її основні характеристики.
Наприклад: Програма призначена для розв’язання завдань пошуку ... Програма використовується самостійно (не вимагає інших програм). Користувач має можливість знайти ..., відредагувати дані про …( додати, видалити, змінити вже існуючі), переглянути дані про ….
У розділі «Опис логічної структури»вказують:
– опис структури програми та її основних частин.
– опис функцій складових частин і зв'язків між ними;
– відомості про мову програмування;
– опис вхідних і вихідних даних для кожної зі складових частин;
– опис логіки складових частин.
При описі структури програми та її основних частин можна вказати, наприклад, таке:
До складу програми входять наступні модулі:
– інтерфейсний;
– базового класу CbazeClass;
– класу спадкоємця Cavto;
– класу - колекції CAvtoServise.
При описі функцій складових частин і зв'язків між ними можна написати так:
Програма складається із чотирьох модулів: інтерфейсного та модулів класів. Інтерфейс побудований на діалозі типу «меню». Інтерфейсний модуль керує взаємодією ... . Модуль базового класу BazeClass містить опис ... Він є базовим в ієрархії класів ... і т.д.
Коли подаються відомості про мову програмування можна вказати таке, наприклад:
Програма написана мовою ... з використанням компілятора ... .
При опису вхідних і вихідних даних для кожної зі складових частин вказують, наприклад:
Вхідними даними для функції читання даних з файла є текстовий файл, що містить дані про … . Вихідними даними є:
- двонаправлений список з головним та хвостовими елементами ….
При опису логіки складових частин потрібно навести опис структури програми. Приклад структури програми подано у додатку Е.
При опису логіки програми необхідна прив'язка до тексту програми.
У розділі «Умови застосування» вказуються умови, які необхідні для виконання програми, наприклад:
Програма експлуатується на IBM-сумісних ПК під керуванням ОС Windows 2000/XP/2003/Vista. Для роботи в діалоговому режимі використається екран монітора, клавіатура та маніпулятор типу «миша». Вхід-ні дані зберігаються на зовнішніх носіях CD-R/RW, FLASH-RAM або HDD.
У розділі «Вхідні та вихідні дані»вказують:
Вхідними даними для програми є текстовий файл, що містить дані про … . Вихідними даними є:
– виведена на екран текстова інформація про … ;
– текстовий файл – результат редагування даних.
У розділі «Склад і функції» вказують опис складу й функції програми, застосовуваних методів розв’язання завдань.
У розділі «Виклик і завантаження» можна вказати, наприклад, так:
Завантаження програми здійснюється набором у командному рядку DOS імені завантажувального файла – INFO.EXE з можливою вказівкою імені файла даних.
