4.3 Опис програмних документів
4.3.1 Загальні вимоги
Згідно вимог ГОСТ 19.105-78 [4] програмні документи складаються:
з титульної частини;
інформаційної частини;
основної частини.
Титульна частина програмного документа містить:
аркуш затвердження (див. додаток А). Це завжди перший аркуш документа. Він не нумерується;
титульний аркуш (див. додаток Б), це друга сторінка документа; її номер – 1, але номер на цій сторінці не ставиться.
Інформаційна частина документа містить:
анотацію – це стисла інформація (до 5 рядків) про зміст доку-мента; пишеться українською, російською та англійською мовами на одній сторінці; розташовується за титульним аркушем; номер аркуша анотації два, але цей номер на аркуші не ставиться;
зміст (зміст містить усі документи, крім специфікації).
Основна частина документа містить:
перелік умовних позначень, символів, одиниць, скорочень і термінів (цей аркуш може бути відсутнім у документі);
текстову частину документа.
Зверніть увагу.Нумеруються всі сторінки документа, починаючи з титульного аркуша. Проставляються номери, тільки починаючи з другої сторінки змісту.Номер сторінки записується у верхньому її колонтитулі справа.
На всіх сторінках (починаючи з анотації) у верхньому колонтитулі посередині проставляється шифр документа.
Увага: при описі програмних документів у пунктах 5.3.2 – 5.3.7 буде подано склад основної частини відповідного документа, а курсивом – приклади, що можуть бути використані студентами як зразки при розробці даного документа.
4.3.2 Специфікація
Специфікація розробляється згідно з вимогами ЄСПД ГОСТ 19.202-78 [5]; є основним програмним документом для розроблюваних програмних продуктів; розробляється на форматних аркушах (рис. 3) і, по суті, є переліком документів, що розроблені на програмний виріб.
|
Позначення |
Назва |
Примітка |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
70 |
30 |
80
Рисунок 3 – Форма специфікації
У специфікацію вносять програмні документи на дану програму, крім специфікації та технічного завдання, у порядку зростання коду виду документа, що входить до складу шифру документа (див. додаток Г).
Лист затвердження будь-якого програмного документа у специфікації записується окремим рядком.
У графі «Позначення» указують шифри розроблених документів програми, у графі «Назва» – назву і вид документа на дану програму та повну назву програми, у графі «Примітка» – додаткові відомості про програму.
4.3.3 Текст програми
Оформлення тексту програми регламентуються ЄСПД ГОСТ 19.401-78 [6], код - 12.
Текст програми повинен бути простим для сприйняття, для цього необхідно забезпечити форматування тексту та наявність коментарів.
Основна частина документа повинна складатися з текстів одного або декількох розділів, яким присвоєні назви. У випадку наявності більше одного розділу необхідно передбачити Зміст документа.
Текст кожного програмного файла починається з «шапки», у якій указується: назва програми, автор, дата створення програми, номер версії, дата останньої модифікації. У додатку Д подано приклад тексту програми.