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

При оформленні пояснювальної записки слід керуватися ДСТУ 3008-95 “ДОКУМЕНТАЦІЯ. Звіти у сфері науки і техніки. Структура і правила оформлення”. Пояснювальна записка (ПЗ) повинна бути чітко і акуратно написана чорнилом (пастою) одного кольору (чорними, синіми, фіолетовими) або надрукована через півтора міжрядкові інтервали на машинці або принтері (шрифтом 14 пт) на одній стороні листів білого паперу формату А4 (210х297мм). Допускається (при необхідності) використання листів формату А3 (297х420мм). При машинному способі звіт виконують відповідно до вимог стандартів на виконання документів з використанням друкуючих і графічних пристроїв виводу ЕОМ (ГОСТ 2.004-88). При написанні ПЗ необхідно дотримувати наступні розміри полів: верхнє, ліве і нижнее – не менше 20 мм, праве – не менше 10 мм. Розмір лівого поля, що рекомендується, – 35-40мм.

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

Пояснювальну записку умовно розділяють на наступні частини:

• ввідна частина;

• основна частина;

• додатки;

• документація.

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

• титульний лист;

• завдання на проектування;

• реферат;

• зміст;

• перелік умовних позначень, символів, одиниць, скорочень і термінів;

• вступ.

Структурні елементи ПЗ «титульний лист», «завдання на проектування», «реферат», «зміст», «перелік умовних позначень, символів, одиниць, скорочень і термінів», «вступ», «висновок», «список використаних джерел» не нумерують, а їх найменування служать заголовками структурних елементів.

Титульний лист є першим аркушем ПЗ. Приклад оформлення титульного листа курсового проекту приведений в додатку Г.

Завдання на курсовий проект оформляється по встановленій формі (на двох сторонах одного аркуша формату А4; при нумерації сторінок ПЗ завдання вважається як дві сторінки).

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

Реферат повинен містити:

• відомості про об'єм ПЗ, кількість ілюстрацій, таблиць, додатків, кількості використаних літературних джерел (всі відомості приводять включаючи дані додатків), відомості про об'єм графічної частини проекту;

• текст реферату;

• перелік ключових слів.

Текст реферату повинен відображати інформацію, представлену в проекті, в такій послідовності:

• об'єкт проектування;

• мета роботи;

• отримані результати;

• основні конструктивні, технологічні і техніко-експлуатаційні характеристики і показники;

• область застосування;

• значущість роботи і виводи;

• прогнозні припущення про розвиток об'єкту дослідження або розробки.

Пункти, по яких відсутні відомості, допускається не приводити.

Реферат необхідно виконувати об'ємом не більше 500 слів, і, бажано, щоб він уміщався на одній сторінці формату А4.

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

Приклад складання реферату приведений в додатку І.

Зміст поміщають після реферату, починаючи з нової сторінки.

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

Перелік умовних позначень, символів, одиниць, скорочень і термінів повинен містити всі використані в тексті умовні позначення, символи, одиниці вимірювання, скорочення і терміни. Перелік розташовують безпосередньо після змісту на новій сторінці. Незалежно від наявності в переліку при першій появі цих елементів в тексті ПЗ приводять їх розшифровку. Приклад оформлення переліку приведений на сторінці 4.

У вступі стисло висловлюють:

• оцінку сучасного стану проблеми;

• актуальність даної роботи і підстава для її проведення;

• мета роботи і область застосування.

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

Якщо заголовок складається з двох або більше речень, їх розділяють крапкою. Перенесення слів в заголовку розділу не допускаються. Відстань між заголовком і подальшим або попереднім текстом повинно бути при машинописному способі – не менше трьох інтервалів, при машинному способі – не менше двох рядків. Відстань між основами рядків заголовків, а також між двома заголовками приймають таким же, як в тексті. Не допускається розміщувати найменування розділу, підрозділу, а також пункту і підпункту в нижній частині сторінки, якщо після нього розташований тільки один рядок тексту. Абзацний відступ повинен бути однаковим по всьому тексту звіту і рівним п'яти знакам (приблизно 1,27 см).

Нумерація. Сторінки ПЗ слід нумерувати арабськими цифрами, дотримуючи наскрізну нумерацію по всьому тексту. Номер сторінки проставляють в правому верхньому кутку сторінки без крапки в кінці. Титульний лист, завдання на проектування, реферат і зміст включають в загальну нумерацію сторінок звіту. Номер сторінки на цих листах не проставляють. Рисунки і таблиці, розташовані на окремих сторінках, включають в загальну нумерацію сторінок.

Розділи, підрозділи, пункти, підпункти ПЗ слід нумерувати арабськими цифрами. Розділи повинні мати порядкову нумерацію і позначатися арабськими цифрами без крапки, наприклад, 1, 2, 3 і так далі Підрозділи повинні мати порядкову нумерацію в межах кожного розділу - номер підрозділу складається з номера розділу і порядкового номера підрозділу, розділених крапкою. Після номера підрозділу крапку не ставлять, наприклад, 1.1, 1.2 і так далі Пункти повинні мати порядкову нумерацію в межах кожного розділу або підрозділу. Якщо розділ або підрозділ складається з одного пункту, або пункт складається з одного підпункту, його нумерують.

Ілюстрації (креслення, рисунки, графіки, схеми, діаграми, фотознімки) слід розташовувати в ПЗ безпосередньо після тексту, в якому вони згадуються вперше, або на наступній сторінці. На всі ілюстрації повинні бути подані посилання в тексті. Якщо ілюстрації створені не автором проекту, то необхідно, представляючи їх в ПЗ, дотримувати вимоги чинного законодавства про авторські права.

Креслення, рисунки, графіки, схеми, діаграми, поміщені в ПЗ, повинні відповідати вимогам стандартів «Єдиної системи конструкторської документації» і «Єдиної системи програмної документації».

Розташовувати ілюстрації слід так, щоб їх було зручно розглядати без повороту ПЗ або з поворотом за годинниковою стрілкою.

Ілюстрації можуть мати назву, яку поміщають під ілюстрацією. При необхідності під ілюстрацією поміщають пояснювальні дані (підрисунковий текст). Ілюстрація позначається словом «Рисунок__», яке разом з назвою ілюстрації поміщають після пояснювальних даних, наприклад, «Рисунок 2.1 – Схема включення приладу». Ілюстрації слід нумерувати арабськими цифрами порядковою нумерації в межах розділу, за винятком ілюстрацій, що приводяться в додатках. Номер ілюстрації складається з номера розділу і порядкового номера ілюстрації, розділених крапкою, наприклад, рисунок 1.2 – другий рисунок першого розділу. Якщо в розділі тільки одна ілюстрація, її нумерують.

Якщо ілюстрація не уміщається на одній сторінці, можна переносити її на інші сторінки, при цьому назву ілюстрації поміщають на першій сторінці, пояснювальні дані – на кожній сторінці, і під ними указують: «Рисунок __, лист __».

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

Таблицю слід розташовувати безпосередньо після тексту, в якому вона згадується вперше, або на наступній сторінці. На всі таблиці повинні бути посилання в тексті ПЗ. Таблиці слід нумерувати арабськими цифрами порядковою нумерацією в межах розділу, за винятком таблиць, що приводяться в додатках. Номер таблиці складається з номера розділу і порядкового номера таблиці, розділених крапкою, наприклад, таблиця 2.4 – четверта таблиця другого розділу. Якщо в розділі одна таблиця, її нумерують. Таблиця може мати назву, яку поміщають над таблицею. Назва повинна бути короткою і відображати зміст таблиці.

Якщо рядки або графи таблиці виходять за формат сторінки, таблицю ділять на частини, поміщаючи одну частину під інший, або поряд, або переносять частину таблиці на наступну сторінку. При цьому в кожній частині таблиці повторюють її головку і боковик. Слово «Таблиця __» указують один раз зліва над першою частиною таблиці, над іншими частинами пишуть: «Продовження таблиці __» з вказівкою номера таблиці.

Заголовки граф таблиці друкують з прописних букв, а підзаголовки – з рядкових, якщо вони складають одну речення із заголовком. Підзаголовки, що мають самостійне значення, пишуть з прописної букви. В кінці заголовків і підзаголовків таблиць крапки не ставлять. Заголовки і підзаголовки граф указують в однині.

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

Формули і рівняння слід нумерувати порядковою нумерацією в межах розділу. Номер формули або рівняння складається з номера розділу і порядкового номера формули або рівняння, розділених крапкою, наприклад, формула (3.3) – третя формула третього розділу. Номер формули або рівняння указують на тому ж рівні в дужках в крайньому правому положенні на рядку. Пояснення значень символів і числових коефіцієнтів, що входять у формулу, слід приводити безпосередньо під нею в тій послідовності, в якій вони дані у формулі. Пояснення значень кожного символу і числового коефіцієнта слід давати з нового рядка. Перший рядок пояснення починають з абзаца словом «де» без двокрапки.

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

При посиланні в тексті ПЗ на використані літературні джерела слід указувати їх порядковий номер по переліку, виділений двома квадратними дужками, наприклад «… у [1-4] ...».

Додатки слід оформляти як продовження пояснювальної записки на її подальших сторінках, розташовуючи додатки в порядку появи посилань на них в тексті ПЗ. Кожний додаток починається з нової сторінки. Додаток повинен мати заголовок, надрукований зверху рядковими буквами з першою прописною симетрично щодо тексту сторінки (наприклад, «Додаток А»).

Додатки слід позначати послідовно прописними буквами українського алфавіту, за винятком Ґ Є, З І, Ї, Й, О, Ч, Ь. Додатки повинні мати загальну з рештою частини ПЗ нумерацію сторінок.

Наявні в тексті додатку ілюстрації, таблиці, формули і рівняння слід нумерувати в межах кожного додатка.