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

Оформлення пояснювальної записки дипломного проекту здійснюється відповідно до діючих стандартів ЄСПД; ЄСКД, а також ДСТУ 3008-2015 ” Інформація та документація. Звіти у сфері науки і техніки. Структура та правила оформлювання ” та інших чинних стандартів.

Технічна документація на автоматизовані системи оформлюється відповідно до міждержавного стандарту ГОСТ 34.201-89 «Информационные технологии. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначение документов при создании автоматизированных систем».

Перелік посилань оформлюється відповідно до ДСТУ8302:2015 « Інформація та документація. Бібліографічне посилання. Загальні вимоги та правила складання »

Посилання на джерела в дипломному проекті повинні подаватися у такий спосіб: у квадратних дужках вказується номер джерела за списком та номери сторінок у ньому, на яких викладено відповідні дані (думки тощо). Квадратні дужки проставляються безпосередньо за текстом, якого стосується посилання. Наприклад: «деякі автори доводять, що ці витрати не виконують функцію компенсації державі витрат на фінансування й утримання спортивної споруди [8, с.125-128]»; число «8» в даному прикладі – це номер, під яким розміщено зазначену роботу у переліку  джерел посилань, а «с.125-128» - це номери сторінок, на яких викладено відповідну позицію авторів.

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

Посилаючись, треба використовувати такі вирази: «у розділі 4», «див. 2.1», «відповідно до 2.3.4.1», «(рисунок 1.3)», «відповідно до таблиці 3.2», «згідно з формулою (3.1)», «у рівняннях (1.23)— (1.25)», «(додаток Г)» тощо.

Дозволено в посиланні використовувати загальноприйняті та застандартовані скорочення згідно з ДСТУ 3582, наприклад, «згідно з рис. 10», «див. табл. 3.3» тощо.

Посилаючись на позицію переліку, треба зазначити номер структурного елемента звіту та но­мер позиції переліку з круглою дужкою, відокремлені комою. Якщо переліки мають кілька рівнів - їх зазначають, наприклад: «відповідно до 2.3.4.1, б), 2)»

  Вимоги до оформлення

Для тексту, таблиць використовується:

- шрифт Times New Roman;

- розмір шрифту 14 пт;

- інтервал шрифту – «Обычный», масштаб - 100%, «Смещение» – нема;

- абзац – 12,5 мм (5 друкованих знаків);

- інтервал після та перед рядком дорівнює 0 пт;

- інтервал абзацу – «Полуторний»;

- береги: лівий – 25 мм., правий – 10 мм, верхній – 25 мм і нижній – 20 мм.

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

Кожний розділ починається з нового аркуша.

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

На останньому аркуші розділу текст має займати не менше 10 рядків.

Не допускається розміщувати в кінці аркуша заголовок підрозділу, пункту чи підпункту, якщо після цього текст займає до двох рядків.

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

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

Приклад

Формула С=А+В. В тексті йде роз’яснення, що таке А, В, і С, тоді їх виділяють курсивом для наочності й розуміння відмінності мови подання.

Оформлення назв, імен, власних імен

Прізвища, назви установ, організацій, фірм та інші імена власні в документі подають мовою оригіналу. Допускається транслітерувати власні імена та подавати назви організацій у перекладі мовою записки з додаванням (при першому нагадуванні) оригінальної назви.

Структурні елементи

Структурними елементами пояснювальної записки є «АРКУШ ЗАТВЕРДЖЕННЯ», «ЛИСТ ЗАВДАННЯ», «Зміст», розділи: «Вступ», «технічні характеристики», «комп’ютерна система», «ОБ’ЄКТНО-ОРІЄНТОВАНЕ ПРОЕКТУВАННЯ», «ПРОГРАМУВАННЯ ТА ТЕСТУВАННЯ», «ОЧІКУВАНІ ТЕХНІКО-ЕКОНОМІЧНІ ПОКАЗНИКИ», «Охорона праці», «висновки», «ПЕРЕЛІК ДЖЕРЕЛ ПОСИЛАННЯ», «додатки».

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

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

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

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

Відстань між рядками заголовку (розділу, підрозділу, пункту, підпункту) або між двома заголовками приймають таку як в основному тексті.

Дотримуються ідентичного оформлення заголовків пунктів і підпунктів. Не допускається щоб пункт за номером 1.2.1 не мав заголовку, а пункт за номером 1.2.2 – мав. Те ж стосується й підпунктів.

Приклад

1 НАЗВА РОЗДІЛУ

1.1 Назва підрозділу

(рядок)

(рядок)

Текст текст текст текст текст текст текст текст текст текст текст текст текст текст текст текст [1].

(рядок)

     1.2 Назва підрозділу

(рядок)

Нумерація

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

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

Номер підрозділу складається з номеру розділу і порядкового номеру підрозділу, що розділяються крапкою.

Приклад

 1.2 Назва другого підрозділу 1-го розділу

 

Номер пункту складається з номеру розділу, номеру підрозділу і порядкового номеру пункту, що розділяються крапкою.  

Приклад

1.2.1 Назва першого пункту другого підрозділу 1-го розділу

 

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

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

  Титульний аркуш включають у загальну нумерацію. Номер на титульному аркуші не ставлять. Титульний аркуш має номер 1, лист завдання, що має зворотній бік – має номер 2 відповідно.

Переліки

За необхідністю можуть бути використані переліки. Перед переліком ставлять двокрапку. Перед кожною позицією переліку слід ставити знак «тире» (перший рівень деталізації).

  У разі розвиненої та складної ієрархії переліків дозволено користуватися можливостями текстових редакторів автоматичного створення нумерації переліків (наприклад, цифра—літера—

тире).

  Текст кожної позиції переліку треба починати з малої літери з абзацного відступу від­носно попереднього рівня підпорядкованості.

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

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

  Заголовки колонок таблиці починають з великої літери, а підзаголовки — з малої літери, якщо вони становлять одне речення із заголовком.

  Підзаголовки, які мають самостійне значення, подають з великої літери. У кінці заго­ловків і підзаголовків таблиць крапки не ставлять. Переважна форма іменників у заголовках -однина.

Відстань між таблицею та основним текстом становить один рядок,

Приклад

  Текст текст текст текст текст текст текст.

(рядок)

Таблиця 2.1 – Назва таблиці

(рядок)

Ч.ч	Заголовок графи	Заголовок графи
1	Текст текст текст текст текст	Текст текст текст
2	Текст текст текст текст текст	Текст текст текст

(рядок)

Текст текст текст текст текст текст текст.

Якщо таблиця має розрив то це оформлюється так:

 На 1-му аркуші

 

  Таблиця 2.2 – Назва таблиці

 

Ч.ч	Назва стовпця	Назва стовпця
1	Текст текст текст текст текст текст	Текст текст текст
2	Текст текст текст текст текст текст	Текст текст текст

 

  На 2-му аркуші

Продовження таблиці 2.2

 

Ч.ч.	Назва стовпця	Назва стовпця
3	Текст текст текст текст текст	Текст текст текст
4	Текст текст текст текст текст	Текст текст текст

  Або

    На 1-му аркуші

  Таблиця 2.2 – Назва таблиці

 

Ч.ч	Назва стовпця	Назва стовпця
1	2	3
2	Текст текст текст текст текст	Текст текст текст
3	Текст текст текст текст текст	Текст текст текст

          

     На 2-му аркуші

      Продовження таблиці 2.2

 

1	2	3
3	Текст текст текст текст текст	Текст текст текст
4	Текст текст текст текст текст	Текст текст текст

Оформлення рисунків

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

На всі ілюстрації мають бути посилання в записці. Креслення, рисунки, графіки, схеми, діаграми мають відповідати вимогам стандартів ЄСКД й ЄСПД. Ілюстрації можуть мати назву, яку розміщуютьпіділюстрацією по центру сторінки. Ілюстрація позначається словом «Рисунок < номер> – Назва рисунку», що разом із назвою ілюстрації розміщують після пояснень.

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

За необхідності під ілюстрацією розміщують роз'яснювальні дані (підрисунковий текст).

 

   Приклад

  Рисунок 3.1 – Форма завантаження даних для групи з бази коледжу

  У додатках до номера рисунка входить літера додатка.

      

  Приклад

       Рисунок А.1 – Головна робоча форма програми

 

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

Відстань між ілюстрацією та основним текстом становить один рядок. Якщо роз’яснення мають розповідний характер, то посилання на рисунок пишіть так: на рисунку 2.2 зображений прототип інтерфейсу системи.

 

 Приклад

 

Текст текст текст текст текст текст текст текст текст текст текст текст.

(рядок)

(рядок)

Рисунок 2.2 – Назва рисунка

(рядок)

  Текст текст текст текст текст текст текст текст текст текст текст текст.

 

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

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