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

Тут наводяться результати алгоритмізації у вигляді опису логічної структури програми. При цьому враховується текст програми на мові програмування.

У цьому розділі повинні бути зазначені:

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

1. Назва та призначення функції;

2. Опис функції;

3. Призначення параметрів функції;

4. Характеристика значення, яке повертається функцією;

5. Коротка характеристика особливостей роботи функції.

Зв’язок програми з іншими програмами (якщо він є).

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

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

Вихідні дані. Характер і організація вихідних даних.

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

2.2.9 Висновок

Стислий виклад досягнутих результатів. Обсяг – не більше однієї сторінки рукописного тексту.

2.2.10 Список використаних джерел

Правила оформлення списку використаних джерел наведені в 3.11.

2.2.11 Додатки

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

2.3 Текст програми

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

2.4 Програма і методика випробувань

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

Анотація.

Зміст.

Об'єкт випробувань. Вказується найменування, область застосування і позначення програми, що випробовується.

Мета випробування. Вказується мета проведення випробувань.

Вимоги до програми. Повинні бути наведені вимоги на програму які підлягають перевірці під час випробувань.

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

Методи випробувань. Приводяться описи методів, які використовуються під час випробувань.

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

Для кожного тесту наводяться:

• призначення тесту;

• перелік тестових даних;

• контрольні результати тестових прикладів.

2.5 Інструкція користувачеві

Інструкція користувачеві містить такі розділи.

Анотація (див. п.2.2.1).

Зміст (див. п.2.2.2).

Загальні відомості. У цьому розділі повинні бути зазначені:

• Позначення і найменування програми.

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

• Мови програмування, на яких було написано програму.

Функціональне призначення. Містить клас розв’язуваних задач і (або) призначення програми і відомості про функціональні обмеження її застосування.

Призначення й умови застосування програми. Вказуються призначення й функції, які реалізуються програмою, умови, необхідні для її виконання (тип ЕОМ, операційна система, обсяг оперативної пам'яті, вимоги до складу і параметрів периферійних пристроїв, вимоги до програмного забезпечення і т.ін.).

Характеристики програми. Наводиться опис основних характеристик і особливостей програми (потрібний обсяг пам’яті, часові характеристики, режим роботи, засоби контролю правильності виконання і т.ін.).

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

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

Вихідні дані. Характер і організація вихідних даних.

Повідомлення. Вказуються тексти повідомлень, що видаються програмісту або оператору в ході виконання програми, опис їхнього змісту і дії, які необхідно виконати у випадку появи цих повідомлень.