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

Титульна сторінка

 

Є першою сторінкою пояснювальної записки. Оформлюється за зразком (дивись Додатки).

Шифр (позначення) документа повинен відповідати вимогам ГОСТ 2.201 або визначатися згідно рисунку 7.2:

 

 

Рисунок 7.2 – Структура шифру документа

Завданні на бакалаврську роботу

Це бланк який займає 2 сторінки на 1 листі. У завданні на дипломний проект обов'язково зазначають:

— тему проекту, яка була погоджена з керівником проекту і затверджена відповідно до наказу університету;

— термін завершення роботи;

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

— зміст пояснювальної записки;

— перелік графічного матеріалу;

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

Анотація

Анотація оформляється на 3-му аркущі пояснювальної записки Займає 1сторінку. Номер сторінки не ставлять, в загальну кількість аркушів не входить. Складається в останню чергу після закінчення пояснювальної записки.

В анотації подають:

— скорочений опис об’єкту та задачі досліджень;

— програму та скорочений виклад методики досліджень;

— основні результати та переваги досліджень;

— висновки, рекомендації;

— обсяг ПЗ, графічної частини, кількість додатків, ілюстрацій, використаних джерел.

Заголовок "АНОТАЦІЯ" пишеться шрифтом, прийнятим для заголовків розділів симетрично правій і лівій границям аркуша. Дозволяється, у випадку великого обсягу, розміщати текст анотації з 1 (одним) міжрядковим інтервалом, оскільки обсяг анотації повинен складати лише 1 сторінку.

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

 

Зміст

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

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

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

 

 

 

 

 

 

 

 

					(2)
(14)	(15)	(16)	(17)	(18)
Зм	Арк	№ докум.	Підпис	Дата
Розробник				(1)	Літера	Лист	Листів
Перевірив							(7)	(8)
(10)	(11)	(12)	(13)		(9)
Н.контроль.
Затверджено

 

Рисунок 7.3 - Основний напис першої сторінки ЗМІСТУ

 

Для першого аркуша документа ЗМІСТ передбачений основний напис, зображений на рисунку 7.3 (це лист номер 3), він обов’язково має основний напис за ГОСТ 2.104 у рамці 180*40 мм. У відповідних графах вказуються:

графа 1 - тема роботи, наприклад:

"АВТОМАТИЗОВАНА СИСТЕМА ПРИЙНЯТТЯ РІШЕНЬ ПО КЕРУ-ВАННЮ ЗАПАСАМИ” (Пояснювальна записка);

графа 2 - позначення пояснювальної записки згідно з ГОСТ 2.201; для курсового проектування у графу 2 записують шифр, що складається послідовно із початкових букв навчального закладу, року захисту, номера залікової книжки, порядковий номер студента в Наказі про затвердження теми бакалаврської роботи і дописують ПЗ (пояснювальна записка);

графа 4 - літера, що присвоєна даному документу

графа 7 - порядковий номер аркуша;

графа 8 - загальна кількість аркушів записки (графу заповнюють тільки на першому аркуші записки);

графа 9 - назва факультету та група студента (ФІТІС, гр. ЗПЗ-01);

графа 10 - характер роботи, виконаний особою, яка підписує документ (Н.контроль - нормоконтроль);

графа 11 - прізвища осіб, що підписали документ;

графа 12 - підписи осіб, прізвища яких вказані у графі 11;

графа 13 - дата підписання документа.

Для наступних аркушів пояснювальної записки використовується напис, зображений на рисунку 7.4

						Лист
(14)	(15)	(16)	(17)	(18)	(2)	(7)
Зм	Лист	№ докум.	Підпис	Дата

 

Рисунок 7.4 - Основний напис текстових документів

 

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

Всі розділи окрім розділу «ВСТУП», «СПИСОК СКОРОЧЕНЬ ТА УМОВНИХ ПОЗНАЧЕНЬ», «ВИСНОВКИ», «СПИСОК ЛІТЕРАТУРИ», «ДОДАТКИ» нумерують арабськими цифрами. Додатки позначають буквами кирилиці.

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

 

Список скорочень та умовних позначень

(1-2 сторінки)

 

Для зручності читання технічної літератури при значній кількості умовних позначень, скорочень, абревіатур їх розташовують на окремому аркуші (аркушах) в кінці документу перед переліком термінів. Спочатку подаються позначення латинськими літерами, потім грецькими, а наприкінці - українською (російською) мовою.

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

Якщо в документі вживається специфічна термінологія, то в кінці (перед списком літератури) наводять перелік уживаних термінів з відповідними поясненнями. Перелік включають в розділ ”ЗМІСТ”.

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

Вступ

(1-3 сторінки)

 

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

 

Основна частина

 

Основна частина оформлюється на аркушах формату А4 (297 210) з кутовим штампом за ДСТ 2.104-68 Форма 2а. У деяких випадках дозволяється використовувати аркуші (вкладиші) формату А3(420 297), складені у формат А4. Оформлення здійснюється тільки машинописним засобом з використанням сучасних друкувальних пристроїв. Дозволяється вписувати рукописним засобом чорною ручкою окремі формули, чи символи, що не піддаються роздрукуванню на існуючій техніці.

Посилання в тексті обов’язково повинні бути на всі джерела. Приклади оформлення посилань в тексті: [ 1 ], [ 1 – 5 ], [ 1 – 5, 7, 9 ].

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

 

Висновки

(1-3 с)

 

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

 

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

Відповідно до ГОСТ 7.32-91 список складається в порядку появи посилань у пояснювальній записці, або за абеткою першого прізвища автора. Відомості про джерела даються відповідно до ДСТУ ГОСТ 7.1:2006. "Система стандартів з інформації, бібліотечної та видавничої справи. Бібліографічний запис. Бібліографічний опис. Загальні вимоги та правила складання".

Список літератури оформлюється на аркушах з кутовим штампом за ДСТ 2.104-68 Форма 2а.

Заголовок "список ЛІТЕРАТУРи" пишеться шрифтом, прийнятим для заголовків розділів симетрично правій і лівій границям листа.

Список літератури включає перелік записів про використану в документі літературу, у кожну з яких входять:

― порядковий номер;

― автор чи список авторів;

― найменування;

― видавництво;

― номер і рік видання;

― число сторінок.

Наприклад.

 

СПИСОК ЛІТЕРАТУРИ

1 Репин В. В., Елиферов В. Г. Процессный поход к управлению. Моделирование бізнес-процессов. – 5-е изд. – М.: РИА «Стандарты и качество», 2007. – 408 с.

2 Гордієнко І. В. Інформаційні системи і технології в менеджменті: Навч.-метод. посібник для самостійного вивчення дисципліни – К.: КНЕУ, 2003. – 259 с.

3 Устинова Г. М. Информационные системы менеджмента: Основные аналитические технологи в поддержке принятия решений.: Учебное пособие. – СПб: Издательство «ДиаСофтЮП», 2000. – 368 с.

4 Пономаренко В. С.. Проектування інформаційних систем.: Навч. посібник. – К.: Академія, 2002. – 544 с.

Посилання в тексті обов’язково повинні бути на всі джерела. Приклади оформлення посилань в тексті: [ 1 ], [ 1 – 5 ], [ 1 – 5, 7, 9 ].

 

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

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

Додатки оформлюються на аркушах з кутовим штампом за ДСТ 2.104-68 Форма 2а (за винятком титульних аркушів).

Всі додатки повинні бути перераховані у змісті.

У додатки можуть бути включені описи комп'ютерних програм, розроблених у процесі виконання роботи. Обов’язковими є специфікація; текст програми та опис програми, або інструкція користуваченві. В окремих випадках дозволяється вводити нові додатки.

Рисунки, таблиці, формули нумерують в межах кожного додатка, наприклад, рисунок Г.3 – третій рисунок додатка Г; таблиця А.2 – друга таблиця додатка А; формула (А.1) – перша формула додатка А.

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

Кожен додаток починають з нової сторінки і оформлюється з титульним листом, у якому вказуються:

1) заголовок: "Додаток" і велика літера, що його позначає. Додатки слід позначати послідовно літерами української абетки за винятком літер Ґ Є, З, І, Ї, Й, О, Ч, Ь, наприклад: додаток А, додаток Б;

2) назва системи;

3) назва підсистеми (при необхідності);

4) тип документа ("специфікація", "текст програми", "опис програми");

5) код документа (рисунок 4.4);

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

― Специфікація (без спеціального коду);

― 12 - текст програми;

― 13 - опис програми;

― 31 - опис застосування;

― 33 - інструкція програмісту;

― 34 - інструкція користувачеві;

― 35 - опис мови;

― 51 - програма і методика випробувань;

― 81 - пояснювальна записка;

― 90-99 - інші документи;

6) кількість аркушів у додатку;

7) рік (на останньому рядку сторінки).

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

 

Рисунок 7.5 - Шифр для позначення специфікації.

Наприклад: 482.ЧДТУ.1 7170-01

 

 

Рисунок 7.6 - Шифр для позначення документа

Наприклад: 482.ЧДТУ.1 7170-01 12 1

Додаток А Специфікація. Основним програмним документом є специфікація. Специфікація складається з титульного листа і таблиці з описом документів (Рисунок 7.7).

Додаток Б Текст програми С кладається з титульного листа і тексту програми. Текст програми записується з урахуванням правил написання програм відповідною мовою і повинен бути з докладними коментарями! У додаток включаються лише основні модулі програми.

Додаток В Опис програми. Необхідність цього додатку слід визначити разом з керівником.

Рисунок 7.7 – Форма специфікації

Опис програми складається з титульного листа, анотації, змісту й інформаційної частини, що складається з наступних розділів:

― загальні відомості;

― функціональне призначення;

― опис логічної структури;

― використовувані технічні засоби;

― виклик і завантаження;

― вхідні дані;

― вихідні дані.

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

У розділі "Загальні відомості" повинні бути зазначені: позначення і найменування програми; програмне забезпечення, необхідне для функціонування програми; мови програмування, якими написана програма.

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

У розділі "Опис логічної структури" повинні бути зазначені: алгоритм програми; використовувані методи; структура програми з описом функцій складових частин і зв'язку між ними; зв'язки програми з іншими програмами. Опис логічної структури програми виконують з урахуванням тексту програми вихідною мовою.

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

У розділі "Виклик і завантаження" повинен бути зазначений спосіб виклику програми.

У розділі "Вхідні дані" повинні бути зазначені: характер, організація і попередня підготовка вхідних даних; формат, опис і спосіб кодування вхідних даних.

У розділі "Вихідні дані" повинні бути зазначені: характер і організація вихідних даних; формат і опис вихідних даних.

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

Анотація в додатку оформлюється лише мовою документа. Заголовок "АНОТАЦІЯ" пишеться шрифтом, прийнятим для заголовків розділів симетрично правій і лівій границям аркуша. Анотація в додатку відноситься не до всієї роботи, а тільки до програмного комплексу, або системи. В анотації наводяться відомості про програмний комплекс, що включають у себе засоби розробки, переваги і рекомендації до застосування.

Заголовок "ЗМІСТ" пишеться шрифтом, прийнятим для заголовків розділів симетрично правій і лівій границям аркуша. Зміст включає перелік записів про структурні елементи документа, у кожну з який входять:

― позначення структурного елемента (номер розділа, підрозділу і т.п.);

― найменування структурного елемента;

― номер сторінки.

Загальний обсяг опису програми не повинен перевищувати 6 сторінок.

 

8 Оформлення графічних матеріалів (плакатів)

 

Графічний матеріал оформлюється на листах формату А1 (594 840 мм). Для роздаткового матеріалу формат листів А4 або А3.

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

Креслення блок-схеми виконується на аркуші з кутовим штампом за ДСТ 2.104-68 Форма 1. Блок-схема алгоритму виконується відповідно до ДСТ 19.701-90 (викладені нижче).

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

Після захисту всі плакати згортають відповідно до формату А4 для збереження їх в архіві. Правила згортки і збереження регламентуються ДСТУ.

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

 

Як правило, студентам комп’ютерних спеціальностей необхідно знати і демонструвати організацію і роботу баз даних. При оформленні відповідного плакату необхідно дотримуватись однаковості – однакова ширина таблиць, однакове зображення зв'язків, полів, ключів і т.п. Назви таблиць, структура таблиць і назви полів оформлюються обов'язково мовою документа, за винятком первинних (PK) і зовнішніх (FK) ключів. Така вимога обов'язкова тільки для плакатів, на відміну від пояснювальної записки, у якій усі ці елементи можуть оформлюватися традиційно англійською мовою.