Основні вимоги до оформлення тексту пояснювальної записки

ЗМІСТ 

3. Основні вимоги до оформлення тексту пояснювальної записки

3.1 Загальні правила 

При оформленні текстової частини КР необхідно дотримуватись вимог ДСТУ 3008-95.

Текст ПЗ виконується відповідно до вимог ГОСТ 2.105-95 із застосуванням друкувальних та графічних пристроїв виведення ЕОМ розміром не менше 2,5 мм (редактор Word, шрифт – Times New Roman 14 кегль) через 1 інтервал.

Допускається текст оформлювати машинописним (друкарським) чітким шрифтом (1,5-2 інтервали) або рукописним основним креслярським шрифтом за ГОСТ 2.304-81 з висотою букв та цифр не менше 2,5 мм.

Допускається оформлення пояснювальної записки КР за вимогами ЄСКД. Пояснювальна записка, яка викладається технічною мовою, відноситься до текстових документів. Графічна інформація має подаватись у вигляді ілюстрацій (схеми, графіки, діаграми тощо). Цифрова – у вигляді таблиць.

Відступи від країв аркуша: зверху, знизу і зліва – 20 мм; справа – 10 мм. Абзац – 5 знаків.

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

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

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

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

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

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

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

Заголовки структурних елементів необхідно нумерувати тільки арабськими цифрами.

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

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

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

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

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

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

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

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

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

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

Приклад:

а) текст переліку та його...

продовження;

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

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

2) . . . ;

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

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

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

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

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

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

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

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

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

ж) при написанні одиниць, знак множення заміняють крапкою на середній лінії (·); знак ділення замінюють косою рискою (/);

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

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

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

A₁ = A1 = A(1);

± 20°C = +- 20°C = +- 20 ЦЕЛ;

200 = 200 (+20; -30);

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

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

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

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

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

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

- використовувати математичні знаки <,>, 0, №, %, sin, cos, tg, log та ін. без цифрових або буквених позначень. В тексті слід писати словами “нуль”, “номер”, “логарифм” і т. д.;

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

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

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

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

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

Приклад

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

М_т  = - к G^1,5,          (3.1) 

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

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

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

I  =  [A].          (3.2) 

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

I  =  = 2,2 (А). 

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

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

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

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

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

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

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

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

Наведена форма запису (Рисунок …) відповідає вимогам
ГОСТ 2.105-95. ДСТУ 3008-95 допускає скорочення лише в посиланнях, тобто замість „рисунок …” – „рис. …”. Між ілюстрацією і текстом пропускають один рядок.

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

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

Пояснювальні дані розміщують під ілюстрацією над її позначенням.

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

а – найменування першої частини; б – найменування другої частини

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

Рисунок 3.2 - Структурна схема (а) і часові діаграми (б) роботи фазометра 

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

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

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

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

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

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

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

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

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

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

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

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

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

Для опису визначеного інтервалу значень в найменуваннях граф і рядків таблиці можна використовувати слова: “більше”, “менше”, “не більше”, “не менше”, “в межах”. Ці слова розміщують після одиниці фізичної величини (Напруга, В, не більше), а також використовують слова “від”, “більше”, “до” (Від 10 до 15; більше 15; до 20).

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

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

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

12 – 35

122 – 450.

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

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

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

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

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

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

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

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

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

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