Зміст

1 Правила розробки програмних документів:

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

• пояснювальної записки.

2 Правила оформлення тексту програмних документів:

2.1 Структура дипломного проекту

• оформлення титульного листа;

• оформлення технічного завдання;

• оформлення листа “Зміст”;

• оформлення вступу;

• оформлення тексту документу;

• оформлення заголовків;

• оформлення переліків;

• оформлення формул;

• оформлення графічних матеріалів (рисунків);

• оформлення таблиць;

• оформлення приміток по тексту;

• оформлення додатків;

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

• лист реєстрації змін.

1 Правила розробки програмних документів

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

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

1.3 Відомість дипломного проекту є основним програмним документом. Основний розділ відомості – “Документація заново розроблена”. Назву кожного документу зазначають у графі “Найменування”. Заголовок “Документація” підкреслюють (див. Додаток Д).

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

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

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

1.4 Опис папки має розділ “Документація”. Назву кожного документу зазначають у графі “Найменування”. Заголовок “Документація” підкреслюють (див. Додаток Е).

В розділ “Документація” записують окремі документи, яки є вмістом папки для архиву.

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

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

Таблиця 1.1 – Види документів та їх позначення

Позначення документу	Вид документу
ДД	Титульний лист дипломного проекту
ДО	Опис папки
ДВ	Відомість дипломного проекту
ПЗ	Пояснювальна записка
Э1	Схема електрична структурна
Э2	Схема електрична функціональна
Э3	Схема електрична принципова
ГЧ	Габаритне креслення
ВО	Загальний вигляд приладу
СА	Структура алгоритму
ТБ	Порівняльні таблиці, структура собівартості

1.5 Кожний розроблений програмний документ повинен мати позначення згідно вимог гост 19.103 – 77.

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

КРМК. 010201. 032 ХХХХ

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

Код спеціальності

Варіант завдання

Код документу згідно таблиці 1.1

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

Методичні вказівки по оформленню програмних документів

відповідають вимогам ГОСТ 2.105 – 98; ГОСТ 19.105 – 78; ГОСТ 19.106 – 78

Вимоги до побудови документу

2.1 Структура дипломного проекту:

• етикетка (Додаток А);

• титульний лист (Додаток Б);

• дипломне завдання (Додаток В);

• зміст (Додаток Ж);

• вступ (Додаток К);

• основний текст документу зі схемами, з розрахунками і без розрахунків, з формулами і без формул;

• висновки;

• список літератури;

• додатки.

2.2 Оформлення титульного листа

Назва теми на титульному листі повинна бути стислою. У назві теми не дозволяються:

• скорочення;

• римські цифри;

• математичні знаки.

Для запису дати виконання роботи використовується шість цифр в послідовності: рік, місяць та день виконання роботи без проміжків та розділових знаків. Наприклад: 040525 (25 травня 2004 року).

2.3 Оформлення дипломного завдання

Завдання оформляється згідно Додатку В. В дипломному завданні повинно бути чітко оговорене завдання, терміни виконання та рекомендована література.

2.4 Оформлення листа “Зміст”

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

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

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

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

2.5 Оформлення вступу

При запису вступу в лист “Зміст” порядковий номер не проставляють.

Оформляють вступ окремим листом, на якому по центру листа вказують – Вступ

Вступ повинен вміщувати вимоги (Додаток К).

2.6 Оформлення тексту документа

2.6.1 Текстові документи оформляють на формах 1, 2 ГОСТ 19.105 – 78, формат А4 згідно додаткам Ж та К.

Текст оформляють із застосуванням друкарських пристроїв. Шрифт 14.

2.6.2. Текст документу має бути лаконічним, коротким, логічно послідовним.

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

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

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

Зноски позначають цифрою з дужкою, що винесена на рівень лінії верхнього кордону шрифту.

Наприклад: “друкований пристрій ¹⁾…”.

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

2.6.3 Вписувати в текст формули, цифри, букви, виконувати рисунки потрібно тільки чорними чорнилами, пастою.

2.6.4 Коли наводять найбільше або найменше значення величин, слід вживати словосполучення “повинно бути не більше (не менше)”.

Приклад: Час виконання функції транспонування матриці повинен бути не більше 0,25 с

2.6.5 Числові значення у відсотках слід писати: “…від 63 % до 67 %” або (63  2) %, а не 63  2 %

2.6.6 Римські цифри слід писати тільки для позначення сорту (категорії, класу тощо) виробу, валентності хімічних елементів, кварталів, року, півріччя. В інших випадках пишуть арабські цифри.

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

Наприклад: п’ять шт, 10 А

2.6.8 У тексті документу не дозволяється:

• вживати звороти розмовної мови;

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

• вживати математичний знак (–) перед від’ємним значенням величини. Слід писати слово “мінус”;

• вживати без числових значень математичні знаки, наприклад: > (більше), < (менше), = (дорівнює),  (більше або дорівнює),  (менше або дорівнює),  (не дорівнює), а також № (номер) і % (відсоток).

2.6.9 Відстань від верхньої рамки формату до тексту повинна бути не менша 10 мм, а відстань від нижньої рамки до тексту повинна бути 10 мм.

Відстань рядка-абзацу від поля зліва повинна бути 15 мм, а справа – 5 мм

Відстань від тексту до найменування розділу і від найменування розділу до тексту повинна бути 10 мм

2.7 Поділ тексту документу

2.7.1 Текст документу слід поділяти на розділи. Розділи можна поділяти на пункти або підрозділи і пункти. Пункти, за необхідності, можуть поділятися на підпункти.

При поділу тексту документу на пункти і підпункти необхідно, щоб кожний пункт, підпункт мав завершену інформацію.

2.7.2 Розділи, підрозділи, пункти і підпункти слід нумерувати арабськими цифрами і друкувати з абзацного відступу.

2.7.3 Розділи повинні мати нумерацію в межах всього тексту, за винятком Додатків.

Нумеруються розділи арабськими цифрами 1, 2, 3 без крапок.

Приклад:

2 Економічна частина

3 Охорона праці

Номер підрозділу включає номер розділу і порядковий номер підрозділу, відокремленого крапкою.

Приклад:

(Розділ) 2 Економічна частина

(Підрозділ) 2.1 Обґрунтування доцільності розробки програми

Номер пункту включає номер розділу, підрозділу і пункту, відокремлені крапкою.

Приклад:

(Розділ) 2 Економічна частина

(Підрозділ) 2.1 Обґрунтування доцільності розробки програми

(Пункт) 2.1.1 Аналіз ринку програмного забезпечення

Номер підпункту включає номер розділу, підрозділу, пункту і підпункту, відокремлених крапкою.

Приклад:

(Розділ) 2 Економічна частина

(підрозділ) 2.1 Обґрунтування доцільності розробки програми

(пункт) 2.1.1 Аналіз ринку програмного забезпечення

(підпункт) 2.1.1.1 Вітчизняний ринок

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

2.8 Оформлення заголовків

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

2.8.2 Заголовки розділів, підрозділів, пунктів, підпунктів слід друкувати з абзацного відступу з великої літери без крапок у кінці, не підкреслюючи.

2.8.3 Якщо заголовок складається із двох речень, їх відокремлюють крапкою.

2.9 Оформлення переліків

У середині пунктів можуть бути наведені переліки. Перед кожною позицією переліку слід ставити дефіс (-).

Для подальшої деталізації переліку необхідно використовувати цифри або літери з дужками, наприклад:

Власні функції програми можна класифікувати наступним чином:

• функції введення/виведення;

• обчислювальні функції:

1. обчислення середніх значень;

2. обчислення параметрів системи;

а) коефіцієнт зв’язку.

2.10 Оформлення формул та пояснення до них (експлікації)

Формули, за винятком формул у додатках, мають нумеруватися наскрізною нумерацією арабськими цифрами на рівні формули праворуч відступивши від рамки 10 мм у круглих дужках (1). Одну формулу також нумерують.

Приклад:

Корекція коефіцієнтів зв’язку між процесорними елементами визначається за формулою (5.1)

wij (k) = wij (k – 1) + jyi ,

(5.1)

де w_ij (k) - значення коефіцієнта зв’язку на ітерації номер k;

w_ij (k – 1) - значення коефіцієнта зв’язку на ітерації номер k – 1;

 - коефіцієнт швидкості ітераційного процесу;

_j - значення помилки навчання для процесорного елемента номер j;

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

Слово “де” необхідно писати з абзацу. Вирівнювання експлікації - по дефісу.

На всі формули у тексті документу повинні бути посилання.

Допускається нумерація формул в межах розділу (двома цифрами через крапку.)