Вимоги до оформлення пояснювальної записки

6.1 Оформлення аркуша “Зміст”

6.1.1 Зміст документа оформлюється окремим аркушем, з нової сторінки, не нумерується як розділ і включається в загальну кількість аркушів. Слово “Зміст” друкують посередині сторінки з прописної літери (Додаток Д).

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

6.1.3 Найменування додатків, які включені в зміст записують строчними літерами, крім першої прописної літери.

Наприклад: Додаток А – Текст програми

6.2 Оформлення специфікації

6.2.1 Специфікація є основним програмним документом для компонентів, що застосовуються самостійно. Основні розділи специфікації – “Документація” та “Компоненти”. Назву кожного розділу зазначають у графі “Назва”. Заголовок “Документація” підкреслюють.

6.2.2 В розділ “Документація” записують програмні документи, крім специфікації і технічного завдання, в порядку збільшення коду виду документа.

6.2.3 Після кожного розділу необхідно залишати декілька вільних рядків для додаткових записів.

6.2.4 В графу “Позначення” вносять позначення документів програми.

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

Таблиця 6.1 – Основні види документів та їх коди

Код виду документа	Вид документа
–	Специфікація
	Опис програми
	Керівництво програміста
	Керівництво оператора
	Опис мови

6.2.6 Кожний розроблений програмний документ повинен мати позначення програм і програмних документів згідно вимог ГОСТ 19.103–77.

Позначення програм і документів повинно складатися із коду навчального закладу, проміжку, шестизначного реєстраційного номеру та року розробки програми. Структура позначення програми та специфікації:

Загальна частина позначення

КОУУ.00001 – 04

Код навчального закладу

Реєстраційний номер

Рік розробки документу

Структура позначення інших програмних документів:

КПЕК.00001 – 04 38 01

Код навчального закладу

Реєстраційний номер

Рік розробки документу

Код документу

Номер документу даного виду

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

6.3 Оформлення текстової частини пояснювальної записки

6.3.1 Текстову частину пояснювальної записки (за виключенням програмних документів, що складають розділ 2) оформлюють згідно ГОСТ 2.105–95 ЄСКД.

6.3.3 Текст пояснювальної записки має бути лаконічним, коротким, логічно послідовним.

6.3.4 Терміни і позначення мають бути єдиними і відповідати стандартам, а при їх відсутності загальноприйнятим в науково-технічній літературі і наводитись в переліку термінів. Допускається скорочення слів згідно ДСТУ 3582 – 97. Додаткові скорочення наводяться у переліку прийнятих скорочень.

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

6.4 Оформлення програмних документів

6.4.1 Текстову частину програмних документів, що складають розділ 2 пояснювальної записки, оформлюють згідно ГОСТ 19.106–78 ЄСПД.

6.4.2 Програмні документи оформлюють на аркушах формату А4 (ГОСТ 2.301–68) згідно рисунка 6.1.

1

2

3

20

10

25

15

1 – порядковий номер сторінки;

2 – позначення документу;

3 – текст документу.

Рисунок 6.1 – Форма текстового документа

6.5 Оформлення додатків

6.5.1 Додатки позначаються великими літерами української абетки, починаючи з А, за винятком літер Г, С, З, І, О, Ї, Й, О, Ч, Ь.

6.5.2 Після слова “Додаток” друкують літеру, що позначає його послідовність.

6.5.3 Кожний додаток слід починати з нової сторінки із зазначенням зверху посередині сторінки слова “Додаток” і його позначення.

Якщо додаток один, то він також позначається “Додаток А”.

6.5.4 Розділи, підрозділи, пункти, графічний матеріал, таблиці і формули нумерують у межах кожного додатку.

Перед номером позначення розділу таблиць, рисунків, формул ставлять позначення додатку.

Наприклад: Додаток А; Таблиця А.1; Рисунок А.1.

6.5.5 Додатки мають загальну з рештою документу наскрізну нумерацію.

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

6.5.7 Всі додатки повинні бути перераховані в “Змісті” документу з зазначенням їх позначень і найменувань.

Наприклад:

Додаток А – Схема….

Додаток Б – Специфікація….

6.6 Оформлення списку літератури

6.6.1 Список літератури оформлюють згідно ДСТУ ГОСТ 7.1:2006 “Бібліографічний запис. Бібліографічний опис. Загальні вимоги і правила складання”.

6.6.2 Бібліографічний опис електронних ресурсів оформлюється згідно ГОСТ 7.82–2001.

6.6.3 Посилання в тексті на використані літературні джерела потрібно зазначати порядковим номером зі списку використаної літератури, виділеним квадратними дужками, наприклад:

“… до вимог, наведених у [5]”.

6.7 Оформлення схем алгоритмів

6.7.1 Оформлення схем алгоритмів, програм, даних і систем здійснюється згідно ГОСТ 19.701–90 ЄСПД.

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