4.3. Вимоги до програмних документів проекту

Всі вимоги до оформлення, змісту і структури програмних документів регламентуються Єдиною системою програмної документації (ЄСПД).

Виконання схем алгоритмів і програм необхідно здійснювати згідно ГОСТ 19.002-80 “Схемы алгоритмов и программ. Правила выполнения”, ГОСТ 19.003-80 “Схемы алгоритмов и программ. Обозначения условные графические”, ГОСТ 19.005-85 “Р-схемы алгоритмов и программ”.

Основна термінологія викладена в ГОСТ 19.004, ГОСТ 19.781-90 “Термины и определения”. До основних термінів відносять: алгоритм, програма обчислювальної машини, документ, програмний документ тощо.

Згідно ГОСТ 19.101-77 “Виды программ и программных документов” виділяються наступні:

види програм: компонент, комплекс;
види програмних документів (ПД): специфікація, текст програми, опис програми, пояснювальна записка, експлуатаційні документи.

Специфікація – це склад програми і документація на неї, згідно ГОСТ 19.202-78 “Спецификация”. Вона містить наступні розділи:

документація;
комплекси;
компоненти.

Оформляється програмний документ на листах формату А4.

Текст програми – це запис програми з необхідними коментарями, згідно ГОСТ 19.401-78 “Текст программы”. Оформлення виконується згідно ГОСТ 19.105 –78 “Общие требования к программным документам”.

Опис програми – це відомості про логічну структуру і функціонування програми. Згідно ГОСТ 19.402-78 “Описание программы”, опис включає розділи:

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

Пояснювальна записка містить схему алгоритму, загальний опис алгоритму і (або) функціонування програми, а також обгрунтування прийнятих технічних і техніко-економічних рішень. Згідно ГОСТ 19.404‑79 “Пояснительная записка”, вона включає розділи:

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

Експлуатаційні документи бувають наступних видів:

а) відомість експлуатаційних документів (містить перелік експлуатаційних документів на програму);

б) формуляр (містить основні характеристики програми, комплектність і відомості про експлуатацію програми);

в) опис застосування (містить відомості про призначення програми, область застосування, мінімальна конфігурація технічних засобів); згідно ГОСТ 19.502-78 “Описание применения” опис включає розділи:

анотація;
зміст;
призначення програми;
умови застосування;
опис задачі;
вхідні і вихідні дані;

г) інструкція системного програміста (містить відомості для перевірки, забезпечення функціонування, настроювання програми); згідно ГОСТ 10.503‑79 “Руководство системного программиста” інструкція включає розділи:

анотація;
зміст;
загальні відомості про програму;
структура програми;
налаштування програми;
перевірка програми;
додаткові можливості;
повідомлення системному програмісту;

д) інструкція програміста (містить відомості для експлуатації програми); згідно ГОСТ 19.504-79 “Руководство программиста” інструкція включає розділи:

анотація;
зміст;
призначення і умови застосування програми;
вхідні і вихідні дані;
повідомлення;

є) інструкція оператора (містить відомості для забезпечення процедури спілкування оператора з обчислювальною системою в процесі виконання програми); згідно ГОСТ 10.505-79 “Руководство оператора”, інструкція включає розділи:

анотація;
зміст;
призначення програми;
умови виконання програми;
використання програми;
повідомлення оператору;

ж) опис мови (містить синтаксис і семантику мови); згідно ГОСТ 19.506‑79 “Описание языка” опис включає розділи:

анотація;
зміст;
загальні відомості;
елементи мови;

з) інструкція по технічному обслуговуванню (містить відомості по використанню тестових і діагностичних програм при обслуговуванні технічних засобів); згідно ГОСТ 19.508-79 “Руководство по техническому обслуживанию” інструкція включає розділи:

анотація;
зміст;
вступ;
загальні вказівки;
вимоги до технічних засобів;
опис функцій.

Виконання основних написів згідно ГОСТ 19.104-78 “Основные надписи” приведене на рисунку 5.1.

Відповідно до загальних вимог до програмних документів, згідно ГОСТ 19.105-78 “Общие требования к программным документам”, програмний документ складається з частин:

титульна (лист затверджень, титульний лист);
інформаційна (анотація, зміст);
основна.

Вимоги до програмних документів, що виконані друкованим способом, згідно ГОСТ 19.106-78 “Требования к программным документам, выполненным печатным способом”, є наступними: друкувати на одній стороні листа через два інтервали (допускається через 1; 1.5); на листах формату А4 (форма 1), А3 (форма 2), що подані на рисунках 5.2, а і 5.2, б відповідно.