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

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

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

Пояснювальна записка виконується машинним способом на одній стороні аркушу білого паперу формату А4 (210 х 297 мм) відповідно до ДСТУ 3008-95 "Документація. Звіти у сфері науки і техніки. Структура і правила оформлення" [1] українською мовою або, з дозволу випускаючої кафедри, іншою мовою, що використовується у навчальному процесі.

Структура пояснювальної записки до комп'ютерної дипломної роботи та орієнтовний обсяг розділів (30 - 50 сторінок):

- титульний аркуш – 1 с.;

- лист завдання – 1 аркуш;

- реферат на українській, російській та англійській мовах, а також на мові на якій виконано пояснювальну записку, якщо вона не увійшла у коло означених вище мов – 1-2 с.;

- зміст – 1-2 с.;

- вступ – до 3 с.;

- суть – 20-50 с., в тому числі: ціль роботи, аналіз проблемної галузі і постановка задачі (5-10 сторінок); порівняльний аналіз існуючих методів вирішення задачі та обґрунтування вибору використаного методу вирішення (5-10 сторінок); опис запропонованого рішення (10-25 сторінок), яке повинне включати магістерське дослідження; аналіз можливих використань (1-5 сторінок);

- висновки - 1-2 с.;

- перелік посилань;

- додатки.

Приклад оформлення титульного листа дивися в додатку.

Лист завдання проектування заповнюється за формою № У 6.01. У додатку А наведено приклад заповнення листа завдання на дипломне проектування.

Реферат містить:

- відомості про обсяг пояснювальної записки, кількості її частин, ілюстрацій, таблиць, додатків, кількості джерел за переліком посилань;

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

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

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

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

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

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

У розділі «Аналіз проблемної галузі і постановка задачі» дипломник повинен проаналізувати існуючу ситуацію в науковому, організаційному, технічному і програмному забезпеченні тієї або іншої предметної області, провести аналіз літератури, і сформулювати список наукових, організаційних, практичних задач, що йому необхідно виконати в ході дипломної роботи.

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

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

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

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

Записку виконують із розрахунку не більш 40 рядків на сторінці за умови рівномірного її заповнення і висотою літер і цифр не менше 1,8 мм. Під час написання тексту необхідно додержуватись таких розмірів полів: верхнє, ліве і нижнє - не менше 20 мм, праве - не менше 10 мм.

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

Структурні елементи “РЕФЕРАТ”, “ЗМІСТ”, “ВСТУП”, “ВИСНОВКИ”, “ПЕРЕЛІК ПОСИЛАНЬ”) не нумерують, а їхні найменування є заголовками структурних розділів. Розділи і підрозділи повинні мати заголовки. Пункти і підпункти можуть мати заголовки. Заголовки структурних елементів записки і заголовки розділів необхідно розташовувати в середині рядка і друкувати прописними літерами без крапки наприкінці, не підкреслюючи. Заголовки підрозділів, пункти і підпунктів записки необхідно починати з абзацного відступу і друкувати малими літерами, крім першого прописного, не підкреслюючи, без крапки наприкінці. Абзацний відступ повинен бути однаковим по всьому тексту записки і дорівнювати п'ятьом знакам. Якщо заголовок складається з двох або більш речень, їх розділяють крапкою. Переноси слів у заголовку розділу не допускаються.

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

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

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

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

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

Ілюстрації розташовують у пояснювальній записці безпосередньо після тексту, в якому вони вперше згадуються, або на наступній сторінці. На всі ілюстрації повинні бути посилання в пояснювальній записці. Ілюстрації можуть мати назву, що розташовують під ілюстрацією. При необхідності під ілюстрацією розташовують пояснювальні дані. Ілюстрація позначається словом “Рисунок ”, що разом із назвою рисунку поміщають після пояснювальних даних, приклад оформлення наведено у додатку А. Ілюстрації необхідно нумерувати арабськими цифрами порядковою нумерацією в межах розділу, за винятком ілюстрацій, наведених у додатках. Номер ілюстрації складається з номера розділу і порядкового номера ілюстрації, розділених крапкою. Якщо ілюстрація не розміщується на одній сторінці, її можна переносити на інші, при цьому назву ілюстрації розташовують на першій сторінці, пояснювальні дані - на кожній сторінці, і під ними вказують: “Рисунок   , аркуш ”.

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

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

Посилання в тексті на джерела необхідно наводити у порядку їх згадування в записці, вказуючи порядковий номер, виділений двома квадратними дужками, наприклад: [5].

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

Перелік посилань оформлюється як розділ пояснювальної записки з нової сторінки відповідно до вимог ГОСТ 7.1-84 "Библиографическое описание документа. Общие требования и правила составления".

Для оформлення бібліографічних посилань, правильного запису загальноприйнятих скорочень рекомендується використовувати методичні вказівки [2], складені з урахуванням відповідних стандартів. Приклад оформлення переліку посилань наведено у додатку А.

Додатки пояснювальної записки необхідно оформляти як продовження пояснювальної записки на наступних її сторінках, або в окремій частині, розташовуючи додатки в порядку появи посилань на них у тексті пояснювальної записки. Кожний додаток повинен починатися з нової сторінки і мати заголовок, надрукований вгорі малими літерами з першої прописної симетрично щодо тексту сторінки. Посередині рядка над заголовком малими літерами з першої прописної повинне бути надруковане слово “Додаток ” і прописна літера, що позначає додаток. Додатки слід позначати послідовно прописними буквами українського алфавіту, за винятком літер Г, Є, З, І, Ї, Й, О, Ч, Ь. Додатки повинні мати загальну з іншою частиною пояснювальної записки наскрізну нумерацію. Текст кожного додатка, при необхідності, може бути розділений на підрозділи і пункти, що нумеруються арабськими цифрами в межах кожного додатка.

З тильної сторони передньої частини обкладинки приклеюються два стандартні поштових конверти з написами «ВІДГУК» і «РЕЦЕНЗІЯ», у які вкладаються відповідні документи. На задній обкладинці приклеюється конверт для дискети з Додатком А.

Якщо у дипломній роботі виконувалась розробка програмної системи, то вона повинна пройти через всі етапи, передбачені ЕСПД (ГОСТ 19 або відповідний діючий Держстандарт на момент дипломування). А саме: етап технічного завдання, у якому повинні бути визначені головні вимоги замовника, перелік задач, що розв'язуються системою, структуру системи, список головних функцій, головні вимоги до програмно-технічного забезпечення. Результатом цього етапу повинен бути текст технічного завдання відповідно до ГОСТ 19. 201-78. Етап проектування і програмування передбачає розробку структури вхідних і вихідних даних, математичної моделі вирішення задачі, алгоритму вирішення задачі, визначення семантики і синтаксису мови опису даних у системі, визначення конфігурації технічних засобів, розробку програмної системи, створення методики тестування і налагодження. Результатом цього етапу є: пояснювальна записка, складена відповідно до ГОСТ 19.404-79, у яку повинні увійти розроблені на етапі ескізного, технічного і робочого проектування схеми (перелік схем визначається використовуваною технологією проектування); опис застосування - ГОСТ 19.502-78; керівництво системного програміста - ГОСТ 19.503-79; Керівництво програміста - ГОСТ 19.504-79; керівництво оператора - ГОСТ 19.505-79; текст програми (вихідний текст програми повинен містити достатню кількість коментарів) - ГОСТ 19.401-78. Усі зазначені в даному розділі документи повинні бути оформлені у вигляді файлів у форматі MS WORD і віднесені до Додатку А у пояснювальній записці до дипломної роботи.