Вимоги по оформленню пояснювальної записки
Варто звернути увагу на окремі особливості оформлення ПЗ. Пояснювальна записка подається у друкованому вигляді. Допускається комп’ютерний набір та друк. Обсяг пояснювальної записки – 40-60 сторінок друкованого тексту (враховуючи таблиці, схеми, графіки, діаграми та ін.) через 1,5 інтервали, на одній стороні листа папера формату А4 (210x297 мм).
За необхідністю можна використовувати також папір формату А3 (297х420 мм) для виконання таблиць та ілюстративного матеріалу.
Шрифт Times New Roman Cyr, кегль 14. Кожен розділ ПЗ починають з нового листа.
Нумерація сторінок ПЗ повинна бути наскрізною, першою сторінкою є титульний лист, друга та третя - завдання на проектування, четверта – календарний план курсового проектування, п’ята - список листів графічного матеріалу, шоста – реферат, сьома - зміст і т.п. У нумерацію сторінок ПЗ включають графіки, таблиці, схеми, креслення й інші матеріали, виконані на окремих аркушах і вшиті в загальну підшивку.
Усі складові частини ПЗ (розділи, підрозділи і пункти) повинні мати порядкові номери, позначені арабськими цифрами з крапкою, наприклад, 2.5.20 - (двадцятий пункт п'ятого підрозділу другого розділу. Якщо розділи на підрозділи не поділяються, то номер пункту складається з номера розділу та номеру пункту, наприклад, 2.5 (п'ятий пункт другого розділу).
Розділи і підрозділи повинні мати найменування у вигляді заголовків. Найменування розділів записують прописними буквами не підкреслюючи, а підрозділів - рядковими (крім першої прописної). Переноси слів у заголовках не допускаються. Крапку наприкінці заголовків не ставлять. Якщо заголовок складається з декількох речень, їх розділяють крапкою.
Номер розділу і підрозділу ставлять перед найменуванням і відокремлюють його крапкою. Номер пункту (підпункту) пишуть на початку першої строки абзацу так, щоб він не виступав за межу абзацу.
Відстань між заголовком і наступним текстом - 15 мм, відстань між заголовком і останнім рядком попереднього тексту - 20 мм.
Виклад тексту ПЗ рекомендується вести від третьої особи: “як показують наші розрахунки”; “ми вважаємо”; “наше рішення” тощо. В тексті ПЗ потрібно дотримуватися єдиної термінології. Не варто зловживати іноземними словами, особливо в тих випадках, коли знаходяться рівнозначні українські слова (терміни). Найменування фірм, заводів, організацій не відмінюються, їх треба включати у лапки.
Формули нумерують арабськими цифрами в межах розділу. Номер формули складається з номера розділу і порядкового номера формули в розділі, розділених крапкою. Номер указують із правої сторони листа на рівні формули в круглих дужках, наприклад: (3.15) (п'ятнадцята формула третього розділу).
Значення символів і коефіцієнтів, що входять у формулу, приводять під формулою. Після формули пишуть слово "де" без двокрапки після нього, за ним - символи і числові коефіцієнти розшифровують у такій послідовності, у якій вони приведені у формулі. Значення кожного символу приводять з нового рядка.
Наприклад:
а=w*A (3.15)
де а – обсяг переданих даних, [біт];
w – пропускна спроможність каналу, [біт/с];
t – час передачі даних, [с].
Всі ілюстрації в ПЗ (креслення, схеми, фотографії, графіки) називають рисунками. Вони повинні мати нумерацію в межах розділів (наприклад: Рисунок 1.5, Рисунок 2.3 і т.д.).
Кожен рисунок повинний мати змістовний заголовок, який пишуть після номера (наприклад: Рисунок 1.5 – Назва 1 і т.д.).
Посилання на рисунки вказують у круглих дужках, наприклад: (рис.1.5). При другому і наступному посиланнях на той самий рисунок додають олово " дивися", наприклад (див. рис.1.5).
Результати розрахунків і деякі розрахунки зводять у таблиці. У відповідності до ДСТУ 3008-95 до кожної таблиці дають точний і короткий заголовок, що відбиває її зміст і ознаку, що відрізняє її від інших таблиць. Розміщають заголовок над таблицею, підкреслювати його не слід. Заголовок пишуть у називному відмінку однини. Крапку після нього не ставлять, заголовки підлеглих ступіней пишуть з малої літери.
Всі таблиці нумерують в межах розділу. Перед тематичним заголовком, з прописної літери цілком пишуть слово “Таблиця” і проставляють її порядковий номер.
Номер таблиці складається з номера розділу і порядкового номера таблиці, розділених крапкою, наприклад; “Таблиця 2.2” (друга таблиця другого розділу).
При посиланні на таблицю в тексті слово “таблиця” пишеться повністю лише при відсутності номера.
Над продовженням таблиці на новій сторінці пишуть "Продовження табл. 2.2" або "Закінчення табл. 2.2" (без лапок), тематичний заголовок не повторюють; всі частини розбитої таблиці починають не передруком заголовку, а рядком з нумерацією, що замінює назви стовпців. Вертикальні стовпці нумерують тільки в тих випадках, коли в тексті на них даються посилання або коли таблиця продовжується на наступній сторінці.
У таблиці дотримують рівновагу її частин: ліва бокова частина не повинна займати більш третини її формату, а висота заголовку – не більше третини висоти таблиці.
Одиниці вимірювань вказують у заголовках. Цифри в стовпцях розташовують так, щоб одиниці знаходилися під одиницями, десятки під десятками і т.д. На цифрові групи числа (починаючи з п’яти знаків) розбивають справа наліво по три цифри проміжками без крапки.
Всі ілюстративні матеріали розміщують відразу після посилання на них. Розташовувати таблиці і графічний матеріал слід так, щоб їх можна було читати без повороту аркуша. Якщо таке розміщення неможливе, то таблиці і ілюстрації розташовують так, щоб для їхнього читання треба було повернути аркуш по годинниковій стрілці.
Необхідно дотримуватись міри насиченості тексту ілюстративним матеріалом. Виходячи зі змісту ілюстративного матеріалу, підбирають найбільш виразну форму ілюстрацій.
При написанні тексту ПЗ застосовують тільки метрологічну термінологію, прийняту стандартами.
Усі метричні величини приводять тільки в одиницях СІ.
Усі терміни та визначення приводять у відповідності до ГОСТ 19.781-90 ЄСПД “Забезпечення систем обробки інформації: програми, терміни та визначення.”
У ПЗ повинна бути відображена загальна схема алгоритму з коментарями, яка охоплює все завдання курсового проекту. Кожна програмна одиниця подається детальною схемою алгоритму.
Роль та призначення кожного блоку схеми алгоритму описується після відповідної схеми алгоритму.
Схеми алгоритмів розробляють у відповідності з ГОСТ 19.005-85 ЄСПД “Р-схеми алгоритмів та програм. Позначення умовні графічні та правила виконання”.
Наведений текст програми треба виконувати у відповідності до ГОСТ 19.401-78 ЄСПД “Текст програми. Вимоги до змісту та оформленню”.
Опис та призначення окремих програм треба виконувати у відповідності до ГОСТ 19.402-78 ЄСПД “Опис програми”.
При проведенні розрахунків на ЕОМ у ПЗ необхідно привести використану для розрахунків формулу, схему і програму розрахунку, дати результати у виді даних, видрукуваних цифро-друкуючим пристроєм ЕОМ.
Усі цитати, а також узяті з друку дані, повинні мати посилання на першоджерела.
Посилання на літературні джерела приводяться в тексті у квадратних дужках. У дужках ставлять порядковий номер джерела, приведеного в описку використаної літератури, номер тому, якщо необхідно, - сторінку, наприклад: [3], [8 , т. 2, с. 42], [15, с. 553].
Список літератури рекомендується складати в наступному порядку:
1. Основні нормативні документи і матеріали (державні і урядові).
2. Друковані джерела суспільно-політичного, соціального, економічного, природничо-наукового, соціально-культурного характеру.
3. Книги.
4. Статті.
5. Дисертації.
6. Автореферати.
7. Патентні документи.
8. Нормативно-технічні документи.
9. Каталоги промислового устаткування виробів.
10. Депоновані рукописи.
11. Ресурси Internet.
У межах кожної групи список формується в порядку алфавіту або черговості згадування документа в тексті.