Правила оформлення пояснювальної записки, Комп’ютерна схемотехніка та архітектура комп’ютера, ВНТУ

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

Курсова робота повинна задовольняти такі вимоги:

• обсяг текстової частини не перевищує 20 − 25  сторінок формату А4 текстової частини;

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

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

Не припускається навіть фрагментарне використання одного і того ж електрон­ного варіанта!

Титульний аркуш  є першою сторінкою КР, яка не нумерується. Титульний аркуш виконується за встановленим зразком (дод. А).

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

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

5.1 Загальні правила оформлення тексту

При оформленні текстової частини пояснювальної записки до КР використовується ДСТУ 3008-95. В таблиці  1  наведені правила оформлені документів, за ДСТУ 3008-95, що слід враховувати при виконанні КР.

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

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

1. титульний лист;

2. індивідуальне завдання на курсову роботу, підписане керівником курсової роботи,і студентом, який отримав це завдання і затверджене зав.кафедри;

3. анотація

4. зміст;

5. вступ;

6. розділ 1;

7. розділ 2;

8. розділ 3;

9. висновок;

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

11. додатки (в разі потреби). 

5.2 Вимоги до оформлення розділів та підрозділів

Структурними елементами основної частини ПЗ є розділи, підрозді­ли, пункти, підпункти, переліки. 

Таблиця 5.2 – Вимоги за  ДСТУ 3008-95 до КР.

Розділ - головна ступінь поділу тексту, позначена номером і має заголовок.

Підрозділ - частина розділу, позначена номером і має заголовок.

Пункт - частина розділу чи підрозділу, позначена номером і може мати заголовок.

Підпункт - частина пункту, позначена номером і може мати заголовок. Заголовки струк­турних елементів необхідно нумерувати тільки арабськими числами.

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

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

Заголовок розділу записують посередині (ДСТУ 3008-95) та з абзацу (ГОСТ 2.105-95) великими буквами з більш високою насиченістю.

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

Розділи нумерують порядковими номерами в межах всього документа (І, 2, і т.д.). Після номера крапку не ставлять, а пропускають один знак.

Підрозділи нумерують в межах кожного розділу, пункти в межах підрозділу і т.д. за формою (3.1,3.2, 3.2.1, 3.2.2,3.2.2.1 і т.д.).

Цифри, які вказують номер, не повинні виступати за абзац.

Посилання в тексті на розділи виконується за формою: "...наведено в розділі 3".

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

Кожну частину переліку записують з абзацу, починаючи з малої букви і закінчуючи крапкою з комою, в кінці останньої ставлять крапку.

Приклад:

а) текст переліку та його...продовження;

б) текст переліку:

1) текст переліку подальшої деталізації та його продовження;

2)...;

в) останній перелік.

Одна примітка не нумерується і після слова "Примітка" ставиться тире (ГОСТ 2.105-95). Текст примітки починають в цьому ж рядку з великої літери і продовжують без абзацу. Якщо приміток кілька, то після слова "Примітки" нічого не ставлять, а записують кожну примітку з абзацу, нумеруючи за порядком арабськими числами. Після номера крапку не ставлять. Примітку починають з великої літери. Продовжують текст примітки без абзацу. Після кожної примітки ставлять крапку.

Примітка - Текст приміток дозволяється друкувати через один інтервал.

Примітки

1___________________

2 __________________

Тексти приміток за ДСТУ 3008-95 (відповідно однієї або декількох)мають вигляд:

Примітка.___________________________

Примітки:

1. (Після кожного номера примітки з великої літери подають текст примітки)

5.3 Правила написання тексту

При написанні тексту слід дотримуватися таких правил:

а) текст необхідно викладати обґрунтовано в лаконічному технічному стилі;

б) умовні буквені позначення фізичних величин і умовні графічні позначення компонен­тів повинні відповідати установленим стандартам. Перед буквеним позначенням фізичної величини повинно бути її пояснення (резистор R, конденсатор С);

в) числа з розмірністю слід записувати цифрами, а без розмірності словами (відстань - 2 мм, відміряти три рази);

г) позначення одиниць слід писати в рядок з числовим значенням без перенесення в наступний рядок. Між останньою цифрою числа і означенням одиниці слід робити пропуск (100 Вт, 2 А);

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

є) позначення величин з граничними відхиленнями слід записувати як: 100 ± 5 мм;

ж) буквені позначення одиниць, які входять в добуток, розділяють крапкою на середній лінії (•); знак ділення замінюють косою рискою (/);

и) порядкові числівники слід записувати цифрами з відмінковими закінченнями (9-й день, 4-а лінія); при кількох порядкових числівниках відмінкове закінчення записують після останнього (3,4,5-й графіки); кількісні числівники записують без відмінкових закінчень (на 20 аркушах); не пишуть закінчення в датах (21 жовтня) та при римських числах (ХШ століття);

к) скорочення слів в тексті не допускаються, крім загальноприйнятих в українській мові і установлених в ГОСТ 2.316-68, а також скорочень, які прийняті для надписів на виробі (в тексті вони повинні бути виділені великими літерами: СЖ, ОРР), а якщо надпис складається з цифр або знаків, то в лапках. Лапками також виділяють найменування команд, режимів, сигналів (“Запуск");

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

знак множення "х" замінювати зірочкою "*" (ГОСТ 2.004-88).

м) не дозволяється:

- допускати професійних або місцевих слів і виразів (техніцизмів);

- після назви місяця писати слово "місяць" (не "у травні місяці", а "у травні");

- використовувати вирази: "цього року", "минулого року", слід писати конкретну дату "у червні 2001 року";

- використовувати позначення одиниць фізичних величин без цифр, необхідно писати повністю: "кілька кілограмів" (за винятком оформлення таблиць і формул);

- з'єднувати текст з умовним позначенням фізичних величин за допомогою мате­ма­тичних знаків (не "швидкість = 5 км/год", а "швидкість дорівнює 5 км/год", не "тем­пер­атура дорівнює - 5° С", а "температура дорівнює мінус 5 °С ");

- використовувати математичні знаки <, >, о, №, %, sin, соs, tg, lоg та ін. без цифрових або буквених позначень. В тексті слід писати словами "нуль", "номер", "логарифм" і т.д.;

- використовувати індекси стандартів (ДСТУ, СНіП, СТП) без реєстраційного номера. 

5.4  Оформлення формул

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

Умовні буквені позначення (символи) в формулі повинні відповідати установленим ГОСТ 1494-77. Їх пояснення наводять в тексті або зразу ж під формулою. Для цього після формули ставлять кому і записують пояснення до кожного символа з нового рядка в тій послідовності, в якій вони наведені у формулі, розділяючи крапкою з комою. Перший рядок

повинен починатися з абзацу з слова "де" і без будь-якого знака після нього.

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

Приклад

Таким чином, момент тертя в кермових опорах

М_т=-кG¹⁵,                         (5.1)

де к - коефіцієнт пропорційності;

G - вага рухомої частини вимірювального механізму.

Одиницю вимірювання, при необхідності, беруть у квадратні дужки

I =  [А].                            (5.2)

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

I =  = 2,2 (А).

Розмірність одного й того ж параметра в межах документа повинна бути однаковою.

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

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

Посилання на формули в тексті дають в круглих дужках за формою: "...в формулі (5.2)"; "... в формулах (5.7, ..., 5.10)". 

5.5 Оформлення ілюстрацій

Для пояснення викладеного тексту рекомендується його ілюструвати графіками, крес­лен­нями, фрагментами схем та ін., які можна виконувати комп'ютерною графікою.

Розміщують ілюстрації в тексті або в додатках.

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

На всі ілюстрації в тексті ПЗ мають бути посилання, які виконують за формою: "...показано на рисунку 3.1." або в дужках за текстом (рис.  3.1), на частину ілюстрації: "... показані на рисунку 3.2,6". Посилання на раніше наведені ілюстрації дають зі скорочений словом "дивись " відповідно в дужках (див. рис. 1.3).

Наведена форма запису (рисунок ...) відповідає вимогам ДСТУ 3008-95 допускає скорочення, тобто замісті „Рисунок ..." - „Рис. ...".

Між ілюстрацією і текстом пропускають один рядок (3 інтервали).

Всі ілюстрації в ПЗ називають рисунками і позначають під ілюстрацією симетрично до неї за такою формою: "Рисунок 3.5 - Найменування рисунка". Крапку в кінці не ставлять, знак переносу не використовують. Якщо найменування рисунка довге, то його продовжують у наступному рядку починаючи від найменування.

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

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

а) - найменування першої частини;

б) - найменування другої частини 

або за ходом найменування ілюстрації, беручи букви в дужки: 

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

Якщо частини ілюстрації не вміщуються на одній сторінці, то їх переносять на наступні сторінки. В цьому випадку, під початком ілюстрації вказують повне її позначення, а під її продовженнями позначають "Рисунок 3.2" (продовження). Пояснюючі дані розміщують під кожною частиною ілюстрації.

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

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

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

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

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

ДСТУ 3008-95 пропонує такий запис таблиці:

Таблиця   ______ - ______________

(номер)     (назва таблиці)

На всі таблиці мають бути посилання за формою: "наведено в таблиці 3.1"; " ... в таблицях 3.1 — 3.5" або в дужках по тексту (табл. 3.6). Посилання на раніше наведену таблицю дають зі скороченим словом "дивись " (див. табл. 2.4) за ходом чи в кінці речення.

Таблицю розділяють на графи (колонки) і рядки. В верхній частині розміщують головку таблиці, в якій вказують найменування граф. Діагональне ділення головки таблиці не допус­кається. Ліву графу (боковик) часто використовують для найменування рядків. Допус­кається не розділяти рядки горизонтальними лініями. Мінімальний розмір між основами рядків — 8 мм. Розміри таблиці визначаються об'ємом матеріалу.

Графу "№ п/п" в таблицю не включають. При необхідності нумерації, номера вказують в боковику таблиці перед найменуванням рядка.

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

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

Текст заголовків і підзаголовків граф може бути замінений буквеними позначеннями, якщо тільки вони пояснені в попередньому тексті чи на ілюстраціях ( D — діаметр, Н - висота і т.д.). Однакові буквені позначення групують послідовно в порядку росту їх індексів, наприклад: (L₁, L₂,...).

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

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

(Напруга, В, не більше), а також використовують слова "від", "більше", "до": (Від 10 до 15; більше 15; до 20)

Дані, що наводяться в таблиці, можуть бути словесними і числовими

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

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

12 - 35

122 - 450.

Дробові числа наводять у вигляді десяткових дробів, з однаково» кількістю знаків після коми в одній графі. Розміри в дюймах можна записувати у вигляді: 1/2", 1/4", 1/8".

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

Таблиці нумерують в межах розділів і позначають зліва над таблицею за формою: "Таблиця 4.2 — Найменування таблиці". Крапку в кінці не ставлять. Якщо найменування таблиці довге, то продовжують з наступному рядку починаючи від слова "Таблиця". Номер таблиці складається з номера розділу і порядкового номера таблиці в розділі розділених крапкою. Дозволяється нумерувати в межах всього документа.

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

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

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

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

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

Інші вимоги до виконання таблиць - відповідно до чинних стандартів на технічну документацію. 

5.7 Зміст

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

Зміст за нумерацією пояснювальної записки є третьою сторінкою, на якій для курсового проекту виконують основний надпис за формою 2 (40^х185 мм), на наступних - за формою 2а (15x185 мм).

Назви заголовків змісту повинні однозначно відповідати назвам заголовків поясню­валь­ної записки за текстом. Нумерація сторінок повинна бути наскрізною. Форми подачі розділів та підрозділів в змісті для КП та КР відрізняються і показані нижче. 

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

Такі розділи КП як: "ВСТУП', "ВИСНОВКИ", "ЛІТЕРАТУРА" ("ПЕРЕЛІК ПО­СИ­ЛАНЬ"), "Додатки" не нумеруються як розділи. 

5.8 Перелік літературних джерел

Форма запису "ЛІТЕРАТУРА" ("ПЕРЕЛІК ПОСИЛАНЬ") відповідає формі запису вступу, основної частини та висновків.

Список містить перелік літературних джерел, на які повинні бути обов'язкові поси­лан­ня в тексті пояснювальної записки. Література (книги, статті,  патенти, журнали) в загальний список записується в порядку. посилання на неї в тексті. Форма запису "ЛІТЕРАТУРА" повинна відповідати ГОСТ 7.1–84, " ПЕРЕЛІК ПОСИЛАНЬ" – ДСТУ 3582–97. Посилання на літературу наводять в квадратних дужках [...], вказуючи порядковий номер за списком.

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

1. Прізвище та ініціали. Назва книги. - Місце видання: Видавництво, рік. - Кількість сторінок с.

(1. Максимович Н.Г. Теорія графів і електричних кіл. - Львів: Вища школа, 1987. -216 с.)

2. Назва книги / Прізвище та ініціали. - Місце видання: Видавництво, рік. - Кількість сторінок с.

Примітка. Великі міста такі, як Київ, Москва дозволяється записувати однією великою буквою з крапкою.

(2. Вимірювання і комп'ютерно-вимірювальна техніка: Навч. посібник /В. О. Поджаренко, В.В. Кухарчук. - К. : НМКВО, 1991. - 240 с.)

3. Прізвище та ініціали. Назва частини книги // Прізвище та ініціали. Назва книги. - Місце видання: Видавництво, рік. - С. Інтервал сторінок.

(3. Хоор К. О структурной организации данньгх // Дал У., Дейкстра 3., ХоорК. Струк­тур­ное программирование. —М. : Мир, 1975. - С. 98-197.)

4. Прізвище та ініціали. Назва частини видання // Назва видання. - рік. - № Число. - С. Інтервал сторінок.

(4. Dreiheller А. Programming Language Incorporating Units of Measure// Informations­technik. - 1997. -№1. - Р. 83-88.)

(5. Ершов А. А. Стабильные методы оценки параметров // Автоматика и Телемаха­ника. – 1978 .- №8. - С. 86-91.)

5. Нормативно-технічні та патентні документи.

(6. ГОСТ 7.9-77. Реферат и аннотация. - М.: Издательстео стандартов, 1981. — 6 с.)

(7. Пат. 3818311, США, МКИ НОЗК 17/60. Схема защиты полупроводникового переключателя. - Опубл. 04.05.84.)

З повагою ІЦ "KURSOVIKS"!