Правила оформлення тексту програмних документів.
Методичні вказівки по оформленню програмних документів
відповідають вимогам ГОСТ 2.105 – 98; ГОСТ 19.105 – 78; ГОСТ 19.106 – 78
Вимоги до побудови документу
2.1 Структура дипломного проекту:
- етикетка (Додаток А);
- титульний лист (Додаток Б);
- дипломне завдання (Додаток В);
- зміст (Додаток Ж);
- вступ (Додаток К);
- основний текст документу зі схемами, з розрахунками і без розрахунків, з формулами і без формул;
- висновки;
- список літератури;
- додатки.
2.2 Оформлення титульного листа
Назва теми на титульному листі повинна бути стислою. У назві теми не дозволяються:
- скорочення;
- римські цифри;
- математичні знаки.
Для запису дати виконання роботи використовується шість цифр в послідовності: рік, місяць та день виконання роботи без проміжків та розділових знаків. Наприклад: 040525 (25 травня 2004 року).
2.3 Оформлення дипломного завдання
Завдання оформляється згідно Додатку В. В дипломному завданні повинно бути чітко оговорене завдання, терміни виконання та рекомендована література.
2.4 Оформлення листа “Зміст”
2.4.1 Зміст документу оформляється окремим листом, з нової сторінки, не нумерується, як розділ і включається в загальну кількість листів. Слово “Зміст” друкують посередині сторінки з прописної літери (Додаток Ж).
2.4.2 У змісті мають бути порядкові номери і назви розділів, за необхідності підрозділів із поданням їх позначення, найменувань із зазначенням номера сторінки, на якій вони розташовані.
2.4.3 Найменування додатків, які включені в зміст записують строчними літерами, крім першої прописної літери.
Наприклад: Додаток А – Текст програми
2.5 Оформлення вступу
При запису вступу в лист “Зміст” порядковий номер не проставляють.
Оформляють вступ окремим листом, на якому по центру листа вказують – Вступ
Вступ повинен вміщувати вимоги (Додаток К).
2.6 Оформлення тексту документа
2.6.1 Текстові документи оформляють на формах 1, 2 ГОСТ 19.105 – 78, формат А4 згідно додаткам Ж та К.
Текст оформляють із застосуванням друкарських пристроїв. Шрифт 14.
2.6.2. Текст документу має бути лаконічним, коротким, логічно послідовним.
Терміни і позначення мають бути єдиними і відповідати стандартам, а при їх відсутності загальноприйнятим в науково-технічній літературі і наводитись в переліку термінів. Допускається скорочення слів згідно ГОСТ 2.316 – 68. Додаткові скорочення наводяться у переліку прийнятих скорочень.
Для виділення окремих понять допускається змінювати інтервали між словами, а також друкувати окремі слова або частини тексту шрифтом, що відрізняється від основного тексту.
Необхідні позначення до тексту документу можуть оформлятися зносками.
Зноски позначають цифрою з дужкою, що винесена на рівень лінії верхнього кордону шрифту.
Наприклад: “друкований пристрій 1)…”.
Текст зноски розміщують в кінці сторінки і відділяють від основного тексту лінією довжиною 30 мм, що проводиться в лівій частині сторінки.
2.6.3 Вписувати в текст формули, цифри, букви, виконувати рисунки потрібно тільки чорними чорнилами, пастою.
2.6.4 Коли наводять найбільше або найменше значення величин, слід вживати словосполучення “повинно бути не більше (не менше)”.
Приклад: Час виконання функції транспонування матриці повинен бути не більше 0,25 с
2.6.5 Числові значення у відсотках слід писати: “…від 63 % до 67 %” або (63 ± 2) %, а не 63 ± 2 %
2.6.6 Римські цифри слід писати тільки для позначення сорту (категорії, класу тощо) виробу, валентності хімічних елементів, кварталів, року, півріччя. В інших випадках пишуть арабські цифри.
2.6.7 Позначення одиниць рахунку та одиниць фізичних величин застосовують у таблицях, поясненнях символів і чисельних коефіцієнтів, що входять до формул, і у тексті тільки при чисельних значеннях та друкують без крапки.
Наприклад: п’ять шт, 10 А
2.6.8 У тексті документу не дозволяється:
- вживати звороти розмовної мови;
- вживати для того самого поняття різні науково-технічні терміни;
- вживати математичний знак (–) перед від’ємним значенням величини. Слід писати слово “мінус”;
- вживати без числових значень математичні знаки, наприклад: > (більше), < (менше), = (дорівнює), ³ (більше або дорівнює), £ (менше або дорівнює), ¹ (не дорівнює), а також № (номер) і % (відсоток).
2.6.9 Відстань від верхньої рамки формату до тексту повинна бути не менша 10 мм, а відстань від нижньої рамки до тексту повинна бути 10 мм.
Відстань рядка-абзацу від поля зліва повинна бути 15 мм, а справа – 5 мм
Відстань від тексту до найменування розділу і від найменування розділу до тексту повинна бути 10 мм
2.7 Поділ тексту документу
2.7.1 Текст документу слід поділяти на розділи. Розділи можна поділяти на пункти або підрозділи і пункти. Пункти, за необхідності, можуть поділятися на підпункти.
При поділу тексту документу на пункти і підпункти необхідно, щоб кожний пункт, підпункт мав завершену інформацію.
2.7.2 Розділи, підрозділи, пункти і підпункти слід нумерувати арабськими цифрами і друкувати з абзацного відступу.
2.7.3 Розділи повинні мати нумерацію в межах всього тексту, за винятком Додатків.
Нумеруються розділи арабськими цифрами 1, 2, 3 без крапок.
Приклад:
2 Економічна частина
3 Охорона праці
Номер підрозділу включає номер розділу і порядковий номер підрозділу, відокремленого крапкою.
Приклад:
(Розділ) 2 Економічна частина
(Підрозділ) 2.1 Обґрунтування доцільності розробки програми
Номер пункту включає номер розділу, підрозділу і пункту, відокремлені крапкою.
Приклад:
(Розділ) 2 Економічна частина
(Підрозділ) 2.1 Обґрунтування доцільності розробки програми
(Пункт) 2.1.1 Аналіз ринку програмного забезпечення
Номер підпункту включає номер розділу, підрозділу, пункту і підпункту, відокремлених крапкою.
Приклад:
(Розділ) 2 Економічна частина
(підрозділ) 2.1 Обґрунтування доцільності розробки програми
(пункт) 2.1.1 Аналіз ринку програмного забезпечення
(підпункт) 2.1.1.1 Вітчизняний ринок
Після позначення розділу підрозділу, пункту і підпункту в документі крапку не ставлять.
2.8 Оформлення заголовків
2.8.1 Розділи, підрозділи повинні мати заголовки. Пункти заголовків не мають. Заголовки мають чітко і коротко відображати зміст розділів і підрозділів.
2.8.2 Заголовки розділів, підрозділів, пунктів, підпунктів слід друкувати з абзацного відступу з великої літери без крапок у кінці, не підкреслюючи.
2.8.3 Якщо заголовок складається із двох речень, їх відокремлюють крапкою.
2.9 Оформлення переліків
У середині пунктів можуть бути наведені переліки. Перед кожною позицією переліку слід ставити дефіс (-).
Для подальшої деталізації переліку необхідно використовувати цифри або літери з дужками, наприклад:
Власні функції програми можна класифікувати наступним чином:
- функції введення/виведення;
- обчислювальні функції:
1) обчислення середніх значень;
2) обчислення параметрів системи;
а) коефіцієнт зв’язку.
2.10 Оформлення формул та пояснення до них (експлікації)
Формули, за винятком формул у додатках, мають нумеруватися наскрізною нумерацією арабськими цифрами на рівні формули праворуч відступивши від рамки 10 мм у круглих дужках (1). Одну формулу також нумерують.
Приклад:
Корекція коефіцієнтів зв’язку між процесорними елементами визначається за формулою (5.1)
| wij (k) = wij (k – 1) + adjyi , | (5.1) |
де wij (k) - значення коефіцієнта зв’язку на ітерації номер k;
wij (k – 1) - значення коефіцієнта зв’язку на ітерації номер k – 1;
a - коефіцієнт швидкості ітераційного процесу;
dj - значення помилки навчання для процесорного елемента номер j;
yi - значення вихідного сигналу процесорного елемента номер i.
Слово “де” необхідно писати з абзацу. Вирівнювання експлікації - по дефісу.
На всі формули у тексті документу повинні бути посилання.
Допускається нумерація формул в межах розділу (двома цифрами через крапку.)
2.11 Оформлення графічного матеріалу (рисунків)
На графічний матеріал по тексту документу повинні бути посилання.
Графічний матеріал повинен розташовуватися безпосередньо після тексту.
Рисунки, схеми, діаграми, що розміщуються в тексті повинні відповідати вимогам ЄСКД.
Графічний матеріал повинен мати тематичну назву, яку розміщують під рисунком, діаграмою, графіком.
Наприклад: на рисунку 2.1 приведена узагальнена схема алгоритму функції читання даних з файлу.
За необхідністю під графічним матеріалом розміщують пояснювальні дані.
Порядковий номер рисунку, слово “Рисунок” і назву рисунку подають під пояснювальними даними, якшо вони є.
Графічний матеріал нумерують наскрізно по тексту. Допускається нумерація в межах розділу двома цифрами через крапку.
На всі рисунки в документі повинні бути наведені посилання на рисунок.
 |
Рисунок 2.1 – Схема алгоритму функції читання даних з файлу
2.12 Оформлення таблиць
2.12.1 Таблиці застосовують для кращої наочності і зручності порівняння показників.
2.12.2 Кожна таблиця повинна мати назву.
Назва таблиці має відображати її зміст, бути точною, короткою. Назву таблиці слід розміщувати над таблицею на відстані 8 мм від таблиці.
При перенесенні частин таблиці на ту саму, або інші сторінки, назву розміщують понад першою частиною таблиці.
Висота рядків у таблиці повинна бути не менше 8 мм.
Таблиця 2.1 – Елементи таблиці
| |||||||
| |||||||
|
2.12.3 Таблиці, за винятком таблиць-додатків слід нумерувати арабськими цифрами наскрізно. Допускається нумерація таблиць в межах розділу.
Якщо у документі тільки одна таблиця, то вона має бути позначеною – “Таблиця 2.1”.
2.12.4 На всі таблиці документу повинні бути наведені посилання в тексті. Наприклад: “… згідно таблиці 2.1”.
2.12.5 Заголовки граф і рядків у таблиці слід друкувати з великої літери, підзаголовки граф – з малої літери, якщо вони складають одне речення із заголовком, або з великої, якщо вони мають самостійне значення.
2.12.6 У кінці заголовків і підзаголовків таблиць крапки не ставляться.
Заголовки і підзаголовки друкують в однині.
2.12.7 Таблиця з усіх сторін обмежується лініями.
2.12.8 Головка таблиці повинна бути відокремлена від решти таблиці лінією товщиною 2S.
2.12.9 Таблицю, залежно від її розміру розміщують під текстом, у якому вперше наведено на неї посилання, або на наступній сторінці.
Допускається розміщувати таблиці вздовж довгого боку листа документа.
2.12.10 Якщо рядки або графи таблиці виступають за формат сторінки по горизонталі, то таблицю поділяють на частини, які розміщують одна під одною. При чому, в кожній частині таблиці повторюють головку і боковик таблиці.
Слово “Таблиця” зазначають один раз зліва над першою частиною таблиці, над іншими частинами таблиці друкують слова “Продовження таблиці 2”.
Наприклад – Таблиця 2.2.
Таблиця 2.2 – Залежність результатів обчислення значення функції від параметрів моделі
| Значення функції | Відносна похибка, % | Внутрішні параметри | Зовнішні параметри | |||
| Кількість елементів | Вид функції | Швид-кість, мкс | Кількість епох | Вікно, % | ||
| 0,233816 | 23,1 | th (x) | 0,1 | |||
| 0,230974 | 22,5 | th (x) | 0,1 | |||
| 0,229082 | 22,0 | th (x) | 0,1 | |||
| 0,228795 | 21,8 | arctg (x) | 0,08 |
Продовження таблиці 2.2
| Значення функції | Відносна похибка, % | Внутрішні параметри | Зовнішні параметри | |||
| Кількість елементів | Вид функції | Швид-кість, мкс | Кількість епох | Вікно, % | ||
| 0,228643 | 21,5 | arctg (x) | 0,08 | |||
| 0,228501 | 21,3 | arctg (x) | 0,08 |
2.12.11 Таблиці з невеликою кількістю граф допускається поділяти на частини і розміщувати одну частину поряд з іншою на одній сторінці, при цьому, повторюють головку таблиці у відповідності з таблицею 2.3.
Таблиця 2.3 – Швидкості виконання функцій модуля Analyzer
| Функція | Кількість елементів у матриці | Функція | Кількість елементів у матриці | ||||
| SInteg | 1,8 | 5,2 | Coder | 10,6 | 50,6 | 823,0 | |
| GetAbs | 0,1 | 0,2 | 0,4 | Decoder | 15,0 | 40,8 | 610,0 |
| GetRes | 0,1 | 0,2 | 0,5 | SetList | 2,3 | 4,6 | 9,2 |
| RunDif | 1,1 | 3,5 | 15,6 | FillList | 0,9 | 1,5 | 2,7 |
2.12.12 Графу “Номер за порядком” для таблиці включати не допускається.
Нумерація граф таблиці арабськими цифрами допускається у випадку, якщо у тексті документу є посилання на них.
За необхідності нумерації показників, поданих параметрів або інших даних, порядкові номери слід зазначити у першій графі (боковику) таблиці, безпосередньо перед їх назвою у відповідності з таблицею 2.3.
2.12.13 Замінювати лапками цифри, що повторюються у таблиці, математичні знаки, знаки відсотка і номера, позначення марок матеріалів і типорозмірів продукції, позначення нормативних документів не дозволяється.
2.12.14 Цифри у графах таблиць мають проставлятися так, щоб розряди чисел у всій графі були розміщені один під одним, наприклад, Таблиця 2.4.
Таблиця 2.4 – Постатейна калькуляція витрат
| Статті витрат | Підприємство “А” | Підприємство “Б” | ||
| Планові | Фактичні | Планові | Фактичні | |
| 1 Сировина | ||||
| 2 Зворотні відходи | ||||
| 3 Покупні вироби | ||||
| 4 Допоміжні матеріали | ||||
| 5 Паливо | ||||
| 6 Електроенергія | ||||
| 7 Основна та додаткова зарплата робітників |
2.12.15 Якщо у таблиці є виноски і примітки, то у кінці таблиці наводять спочатку виноски, а потім примітки і закривають таблицю знизу.
Наприклад – Таблиця 2.5.
Таблиця 2.5 – Типи даних та їх розміри
| Назва типу | Розмір, байт | Назва типу | Розмір, байт | ||
| 1* | 2** | 1* | 2** | ||
| Complex | LongNum | ||||
| Matrix | IVector | ||||
| SOKNumb | DVector | ||||
| * Статична реалізація ** Динамічна реалізація Примітка |
2.12.16 Якщо у таблиці є примітки, то у кінці таблиці наводять примітку, а потім закривають таблицю знизу.
Наприклад – Таблиця 2.6.
Таблиця 6 – Залежність об’єму споживаних ресурсів від виду алгоритму
| Назва алгоритму | Об’єм ОЗП, кбайт | Процесор-ний час, % | Завантаження системи ПДП, % |
| 1 Зворотнє розповсюдження | |||
| 2 Самоорганізація | |||
| 3 Градієнтний спуск | |||
| Примітка – Алгоритм швидкого зворотнього розповсюдження не розглядається |
2.12.17 Якщо всі показники, що наведені в графах таблиць, визначені в одних і тих самих одиницях фізичних величин (наприклад, у грн) то їх позначення необхідно розташовувати над таблицею праворуч, а в разі поділення таблиці на частини – над кожною її частиною.
2.12.18 Якщо в кінці аркуші таблиця переривається і її продовження буде на наступному аркуші, то у першій частині таблиці нижню горизонтальну лінію, що обмежує таблицю, знизу не наносять. Над таблицею на другій сторінці пишуть “Продовження таблиці 2.2”, головку таблиці повторюють завжди, наприклад – Таблиця 2.2.
2.13 Оформлення приміток по тексту документу
2.13.1 Примітки потрібно розміщувати безпосередньо після текстового, графічного матеріалу або в таблиці, до яких відносяться примітки і друкувати примітки потрібно з абзацу.
2.13.2 Якщо примітка одна, то після слова “Примітка” ставиться тире і примітка друкується з прописної літери з абзацу. Одну примітку не нумерують, декілька приміток нумерують арабськими цифрами.
Наприклад:
Примітка – Допускається використання функцій WinApi.
Примітки:
1) Допускається використання кодування в системі Unicode.
2) Функція BeginRead не має аргументів.
2.14 Оформлення додатків
2.14.1 Матеріали, які доповнюють документи, розміщують у додатках.
Додатками можуть бути: графічний матеріал, таблиці великого формату, розрахунки, описання алгоритмів і програм, задач, специфікації.
2.14.2 Додатки позначаються великими літерами української абетки, починаючи з А, за винятком літер Г, С, З, І, О, Ї, Й, Ч, Ь.
2.14.3 Після слова “Додаток” друкують літеру, що позначає його послі-довність.
2.14.4 Кожний додаток слід починати з нової сторінки із зазначенням зверху посередині сторінки слова “Додаток” і його позначення.
Якщо додаток один, то він також позначається “Додаток А”.
2.14.5 Розділи, підрозділи, пункти, графічний матеріал, таблиці і формули нумерують у межах кожного додатку.
Перед номером позначення розділу таблиць, рисунків, формул ставлять позначення додатку.
Наприклад: Додаток А; Таблиця А.1; Рисунок А.1.
2.14.6 Додатки мають загальну з рештою документу наскрізну нумерацію.
2.14.7. У тексті документу на всі додатки повинні бути подані посилання. Додатки розміщують у порядку посилання на них у тексті документу.
2.14.8 Всі додатки повинні бути перераховані в “Змісті” документу з зазначенням їх позначень і найменувань.
Наприклад:
Додаток А – Схема… .
Додаток Б – Специфікація… .
2.15 Оформлення списку літератури
2.15.1 Посилання в тексті на використані літературні джерела потрібно зазначати порядковим номером зі списку використаної літератури, виділеним квадратними дужками, наприклад:
“… до вимог, наведених у [5]”.
2.15.2 У списку літератури наводяться всі використані літературні джерела під час виконання курсових, дипломних, випускних робіт.
Бібліографічні видання наводяться в порядку:
Закони;
Положення;
Посібники;
Журнали та інші документи.
Наприклад:
1 Закон “Про охорону здоров’я”. - Юринком, 1996.
2 Положення про організацію роботи з охорони праці учасників пізна-вально-виховного процесу в установах і закладах освіти № 969 / 6160, 2001.
3 Глушаков С. В. Мова програмування С++. – Х.: Фоліо, 2003.
2.16 Лист реєстрації змін (Додаток Л)
Лист реєстрації змін оформляється окремим листом згідно додатку Л