Код – 51, Оформлення документа Програма й методика випробувань регламентуються ЄСПД ГОСТ 19.301-79 [9].
У цьому документі вказується опис того, що і як необхідно зробити, щоб переконатися в правильності роботи програми і її відповідності вимогам завдання на розробку.
Документ містить такі розділи:
– об'єкт випробувань;
– мета випробувань;
– вимоги до програми та програмної документації;
– порядок випробувань;
– опис тестів та тестових прикладів;
– оцінка результатів випробувань.
Для розділу «Об'єкт випробувань» може бути запропонований такий приклад: Об'єктом випробувань є програма AvtoServise, призначена для ….
У розділі «Мета випробувань»можна написати, наприклад, так:
Перевірка надійності функціонування програми.
У розділі «Вимоги до програми» можна вказати так, наприклад:
Функціонування програми не повинне призводити до перебою роботи операційної системи. Організація діалогу повинна передбачати захист від уведення некоректних даних.
Для розділу «Вимоги до програмної документації» можна запропонувати такий приклад:
Склад програмної документації, пропонованої на випробуванні: Опис програми (ЄСПД ГОСТ 19.402-78); Програма й методика випробувань (ЄСПД ГОСТ 19.301-79); Текст програми (ЄСПД ГОСТ 19.401-78).
У розділі «Порядок випробувань» потрібно вказати, наприклад, так:
Програма працює відповідно до умов експлуатації на IBM сумісних ПК з ОС Windows 2000/XP/2003/Vista.
Порядок проведення випробувань наступний:
Запуск програми здійснюється ... . Далі вибирається ... для чого натискається ... . Потім послідовно вибираються ...
У розділі «Опис тестових прикладів» можна написати так:
Для проведення випробувань пропонуються дані, що зберігаються у файлах ... . Вміст тестових файлів і результати роботи програми наведені в додатку ...
У розділі «Оцінка результатів випробувань» робиться висновок про відповідність об'єкта випробувань вимогам завдання.
Пояснювальна записка
Код – 81. Оформлення документа Пояснювальна записка регламентується ЄСПД ГОСТ 19.404-79.
Документ повинен містити вступ і наступні розділи:
– призначення й область застосування;
– постановку завдання до розробки;
– опис вхідних та вихідних даних;
– опис складу технічних та програмних засобів;
– список використаних джерел інформації.
У Вступі можна дати, наприклад, таку інформацію:
Інформаційно-довідкові системи – це такі програмні оболонки, що призначені для керування базами даних і використовуються, наприклад, для ведення статистики, складання каталогів тощо. Так, інформаційні системи підтримують ведення…..
У розділі «Призначення й область застосування» вказується призначення програми, дається характеристика області застосування.
Наприклад: Призначення розробки – оперування даними про ...; дозволяє виконувати пошук за зразком, сортування, додавання даних, їх видалення тощо. Може використовуватися в …
У розділі «Постановка завдання до розробки» вказують таке:
– аналітичний огляд інформації з порушеного питання;
– завдання на розробку програми;
– опис застосовуваних математичних методів, обґрунтовується вибір сучасної технології програмування, вказується середовище програмування;
– відповідно до обраного шляху проектування словесно описується обрана структура даних, розроблена структура програми та алгоритм її функціонування. Обґрунтовується коректність алгоритму або окремих його фрагментів;
– аналогічно описуються розроблювані підпрограми.
Аналітичний огляд інформації в даному РЗ можна почати так:
В основі функціонування інформаційно-довідкових систем лежить обробка інформації. Режими її обробки можуть бути такими: пакетний, діалоговий, реального часу [2].
Діалоговий режим забезпечує безпосередню взаємодію користувача з системою. Ініціатором діалогу може бути як користувач, так і ЕОМ. В останньому випадку на кожному кроці користувачу повідомляється, що треба робити. …В роботі буде реалізовано….
Дані, що обробляються, в оперативній пам’яті можуть зберігатися у вигляді масиву або лінійного (одно- чи двонаправленого) списку[1] . …
До переваг масиву можна віднести …, до недоліків – ….
До переваг списку можна віднести …, до недоліків – ….
Виходячи з …в розроблюваній програмі для подання даних буде реалізовано ….
У завданні на розробку, виходячи з аналітичного огляду, конкретизується перелік завдань щодо розробки.
При виборі мови і середовища програмування можна зазначити таке:
Об’єктно-орієнтоване програмування має такі переваги: …. Мова програмування … забезпечує …. Тому для розробки програми обрано мову програмування …, а середовище програмування – ….
При розробці структур даних слід виходити з заданого об’єкта та його властивостей. Тут можна запропонувати, наприклад, таке:
Для опису властивостей заданого об’єкта має сенс розробити структуру TPeople з такими полями, як показано в таблиці1.
Таблиця 1 – Поля структури TPeople
Змінна
Тип
Опис
iName [20]
char
прізвище людини
iYear
int
рік народження
. . .
Абстрактний клас СPeople – базовий. Його наслідують класи CStudent та CProfessor . . .
На рис. 1 показано внутрішню структуру та відносини розроблених класів у вигляді UML діаграми.
Рисунок 1 – Схема ієрархії розроблених класів
Дані про всіх студентів будуть заноситися до списку. Для цього треба ввести структуру TList з такими полями, як у таблиці 2.
Таблиця 2 – Поля структури TList
Змінна
Тип
Опис
Info
TAvto
інформаційне поле елемента списку
Next
TList *
адреса наступного елемента списку
Для роботи із списком розроблено клас CList з закритим атрибутом
TList *head ( адреса голови списку) і відкритими методами, перелік яких подано в таблиці 3.
Таблиця 3 – Методи класу CList
Назва функції
Тип результату
Опис
ReadFile()
void
введення даних з файла
ReadConsole()
void
введення даних з клавіатури
WriteFile()
void
запис даних у файл
WriteMonitor()
void
видача даних на екран монітора
Edit()
void
редагування даних
Poisk()
void
пошук даних за зразком
Help()
void
виведення підказки
При опису структури програми можна вказати, наприклад, таке:
Програма складається з таких модулів:
– інтерфейсного, містить функцію main і функції реалізації діалогу;
– модуля, що містить опис класу Сpeople;
– модуля, що містить опис класу Cstudent;
. . .
На рис. 2 подано структуру проекту розробленого програмного продукту.
Рисунок 2 – Структура проекту
При опису функцій слід висвітлити таке:
– призначення;
– посилання на схему алгоритму функції (якщо є);
– порядок роботи.
При опису головної функції main можна зазначити, наприклад, таке:
Функція main координує роботу всіх функцій програми.
Схема алгоритму подана на рис.3.
Порядок роботи: В циклі видається меню, вводиться команда оператора (блок 1) , яка розпізнається в блоці 2 і залежно від значення команди керування передається відповідній функції. Програма припиняє роботу після введення команди «8» .
У розділі «Опис вхідних та вихідних даних» подається обґрунтований вибір методу організації вхідних і вихідних даних, перераховується необхідний набір і джерело вхідних даних, спосіб їх одержання розроблювальною програмою.
Наприклад: Вхідні дані можуть вводитися оператором з клавіатури в такій послідовності …, або з типізованого файла.
Для вихідних даних аргументується вибір носія для їх зберігання та спосіб відображення для користувача.
Вихідні дані зберігаються в типізованому файлі. Типізований файл обрано тому, що у порівнянні з текстовим файлом він має такі переваги: …. До недоліків слід віднести таке ….
У розділі «Список використаних джерел інформації» наводять перелік науково-технічних публікацій, нормативно-технічних документів і інших науково-технічних матеріалів. Докладна інформація про надання переліку джерел подана в п. 6.2.9 даних вказівок.
Увага.В разі необхідності можна об’єднувати окремі розділи документа або додавати інші. В додатку В подано приклад змісту Пояснювальної записки.