3.3.1 Структура програмного документу

Кожен з приведених вище програмних документів може подаватися на різних типах носіїв даних і повинен складатися з наступних умовних частин:

• титульна частина:

- лист затвердження (не входить в загальну кількість сторінок документа);

- титульна сторінка (перша сторінка документу);

• інформаційна частина:

- анотація;

- зміст;

• основна частина:

- текст документа (з рисунками, таблицями і т.д.);

- додатки;

- перелік термінів;

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

- перелік рисунків;

- перелік таблиць;

- предметний вказівник;

- перелік документів, на які здійснюються посилання;

- перелік літературних джерел, на які здійснюється посилання;

- перелік символів та числових коефіцієнтів;

• частина реєстрації змін

- сторінка реєстрації змін.

3.3.1.1 Титульна частина

Згідно ГОСТ 19.104-78, титульна частина складається з листа затвердження (ЛЗ) та титульної сторінки.

Лист затвердження виготовляють на кожний програмний продукт на аркушах паперу формату А4, незалежно від виду документу. Позначення листа затвердження складається з позначення документа, до якого він відноситься і через дефіс шифру ЛЗ. Лист затвердження не входить в загальну кількість сторінок документа. Приклад заповнення листа затвердження приведений у додатку 4.

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

3.3.1.2 Інформаційна частина

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

Зміст. Зміст містить перелік структурних елементів основної частини документа.

У зміст документа включають:

• номери розділів, підрозділів, пунктів та підпунктів, що мають заголовок, а також їх найменування і номери сторінок;

• номери та найменування (при наявності) додатків програмного документа з номерами сторінок

• інші найменування (перелік рисунків, таблиць і т.д.) та номери сторінок.

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

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

Інформаційну частину програмного документа виконують згідно форми, приведена у додатку 2.

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

Основну частину програмного документа виконують згідно форми, приведеної у додатку 2.

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

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

Розділи, підрозділи, пункти та підпункти потрібно нумерувати арабськими цифрами з крапкою. Розділи повинні мати порядковий номер (1, 2, і т.д). Позначення кожного структурного елементу у межах розділу повинно включати позначення всіх структурних елементів, яким підпорядкований даний. (підрозділи 1.1, 1.2; пункти 1.1.1, 1.2.1 і т.д.).

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

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

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

Числа в тексті пишуть у вигляді цифр (12, ІХ), слів (чо­тири, двадцятий) або в буквено-цифровій формі (10-й, 12 млн, 2 % - ний).

Кількісні числівники пишуть у цифровій або буквено-цифровій формі. Якщо речення починається з числівника, то його пишуть літерами (Друга програма...). Числівники при одиницях фізичних величин пишуть тільки цифрами (...напруга складає 200 В...). Іменник після дробового числа узгоджують з дробовою частиною і ставлять у родовому відмінку.

Порядкові числівники пишуть цифрами з відмінковим закінченням, яке повинно бути:

• однобуквеним, якщо останній букві передує голосна,

Правильно: Неправильно:

4-й (четвертий) 4-ий (четвертий)

В 40-х роках (сорокових) В 40-их (сорокових)

• двобуквеним , якщо останній букві передує приголосна.

Правильно: Неправильно:

4-го (четвертого) 4-о (четвертого)

4-те (четверте) 4-е (четверте).

Якщо декілька порядкових числівників ідуть підряд, то відмінкове закінчення ставлять тільки після останнього (...2,4,5-го розрядів...). Якщо порядкові числівники написані через тире, то відмін­кове закінчення ставлять тільки після останнього, коли воно од­накове (...70-80-ті роки...) і біля кожного, коли вони різні (...40-ві-50-ті роки...).

Не нарощують відмінкові закінчення при числівниках, що позначають номер сторінки, тому, таблиці, рисунку і т.п. (в табл. З, на рис. 5.2, на с. 365,...). За таким правилом пишуть дати, коли родове слово є наступним (9 травня, 1890 рік, ...але рік 1999-й). З римськими цифрами нарощування відмінкового закінчення не застосовується.

Межу величин у тексті позначають граничними числами через тире або з прийменниками “від” і “до” (напруга 10-12 В, довжина від 3 до 5 м). Знак тире не застосовують, коли обидві ве­личини від'ємні або одна від'ємна, а друга додатна.

Правильно: Неправильно:

при напрузі від-5 до+10 В при напрузі -5-+10 В

при напрузі від-5 до-10 В при напрузі (-5)-(-10) В

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

Правильно: Неправильно:

частота обертання 10000-20000 об/хв. частота обертання 10-20000 об/хв.

частота обертання 10-20 тис. об/хв. частота обертання 10 тис-20 тис. об/хв

Розмір і допуск на розмір дають в однакових одиницях (50 ± 0.3 мм).

Складні іменники і прикметники з числівником у складі рекомендовано писати в буквено-цифровій формі (через дефіс). Наприклад, 50-річчя, 20-літній. Допускається використовувати змішану форму, коли прикметник, утворений від одиниці фізич­ної величини, замінюють скороченим позначенням цієї одиниці (100-мм отвір, 2-мкм відхилення). Рекомендується в складних прикметниках до складу яких входить слово "процент" заміняти його знаком % із закінченнями -ний, -ного, -ним (10 %-ний, 12 %-ного). Дозволяється писати і без нарощування відмінкового за­кінчення або використовувати нарощування за правилами (10 % надбавка, до 10 %-на надбавка). Проте обов'язковою вимогою є використання однакового написання по всьому тексту.

Написання дати навчального, фінансового року пишуть че­рез косу лінію (1998/99 навчальний рік).В решті випадків між ро­ками ставлять тире, причому другий рік пишуть повністю (в 1998-1999 роках; неправильно: в 1998-99 роках). Слова "рік", "роках", "вік", "віках" пишуть скорочено (p., pp., в., вв.). Слово "рік" не ставиться при датах, що взяті в круглі дужки. На­приклад, "...Програмний продукт був створений фірмою Microsoft (2000), а потім...".

Знаки № (номер), % (процент), § (параграф), °С (градус Цельсія), ′ (хвилина), ″ (секунда) в тексті ставлять тільки при цифрах. Знак № не ставиться перед номером таблиці, рисунка, сторінки, глави тощо. Наприклад, рис. 4, табл. 2.1, с. 387 . Знаки типу №, %, § і т.д. при декількох числах не подво­юються і ставляться до або після ряду чисел.

Правильно: Неправильно:

№1,3,12... №1,№3,№12...

15, 23 і 33% ... 15%, 23% і 33%...

Математичні позначення <,=,> та інші застосовують тільки в формулах. В тексті їх передають словами.

Одиниці фізичних величин. Найменування і буквені позначення фізичних величин Міжнародної системи одиниць повинні строго відповідати між­народним стандартам і рекомендаціям Міжнародної організації стандартизації (ISO).

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

Приклад:

українське міжнародне

ампер А А

вольт В V

радіан рад rad

секунда с s

ньютон Н N

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

кіловат кВт kW

мікрофарад мкФ nF

мілівольт мВ mV

нанометр нм шп

гігагерц ГГц GHz

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

люкс-секунда лс

люмен на квадратний метр лм/м2

ватт на стерадіан-квадратний метр Вт/(срм2)

радіан-квадратний метр на кілограм радм^кг

Ілюстрації. У проектах широко використовують різного роду ілюстрації: рисунки, схеми, діаграми, фото тощо. Позначають їх словом “Рисунок” або “Рис.”. Позначення “Креслення”, “Фігура”, “Схема” не дозволяються. Нумерація рисунків може бути наскрізною (одиночна індексація – Рис. 2), або по розділах (подвійна індексація – Рис. 2.3). Посилаються на ілюстрації у вигляді: “рис. 12” або “рис. 12)”. На раніше згадані ілюстрації посилаються зі скороченим словом “дивися”, наприклад; “див. рис. 2”. Позначення ілюстації розміщуються під нею. Позначення включає: номер ілюстрації, назву, що пояснює зміст ілюстрації.

Якщо ілюстрацію розміщують в таблиці, то помічають буквою Т (Рис. Т-2). Рисунок може мати кілька частин. У цьому випадку окремі частини позначають малими літерами українського алфавіту без дужки, зліва направо і зверху вниз. Позначення такого рисунку матиме вигляд: “Рис. 3.2. Залежність зміни величини v від часу: а – за першу за першу годину; б – за другу годину.” Текстові надписи безпосередньо на рисунку небажані.

Функціональні залежності двох і більше змінних величин у системі координат зображають у вигляді графіків або діаграм. Значення змінних відкладають на осях координат у вигляді шкал. Масштаб шкал повинен бути рівним і не багатозначним. Багатозначні числа змінних виносять у підпис на осі. Наприклад: величина на вісі ординат К∙10^-5 і цифри на шкалі 0,1,2,3… У прямокутній системі координат незалежну змінну прийнято відкладати на горизонтальній осі (осі абсцис). Якщо шкали починаються з різних величин, то біля початку кожної шкали ставлять початкову величину.

Змінні величини позначають одним з наступних способів: символом (S), найменуванням (площа), найменуванням і символом (площа, S). Позначення у вигляді символів і математичних виразів розташовують горизонтально, у вигляді найменування – вертикально. Найбільш доцільно використовувати символи. Одиниці величин пишуть скорочено (за стандартом) після символу або найменування через кому.

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

Таблиці. Оформлення таблиць повинне здійснюватись відповідно до вимог ГОСТ 1.5-85. Таблиця повинна мати назву, яку слід оформляти рядковими буквами і розміщувати над таблицею. Прописними повинні друкуватися заголовні букви і абревіатури.

Нумерація таблиці може бути наскрізною, тобто такою, що проходить через весь документ (Таблиця 1, ...Таблиця 8), або по розділах (для частини 1: Таблиця 1.1, Таблиця 1.2 і т.д.; для частини 2: Таблиця 2.1, Таблиця 2.2 і т.д.). Для спрощення пошуку бажано використовувати нумерацію по частинах. В дода­тках таблиці нумерують римськими цифрами (Таблиця І, Табли­ця П і т.д.).

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

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

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

Таблиця 1.2 Приставки і множники для утворення

десяткових кратних одиниць

Приставка	Позначення		Множник	Приклад
	українське	міжнародне
Тера	Т	T	1012	ТДж
Гіга	Г	G	109	ГВт
Мега	М	M	106	МВт
Кіло	к	K	103	Кг
Гекто	г	H	102	Гл
Дека	да	Da	10	Дал
деци	д	D	10-1	Дм
санти	с	C	10-2	См
мілі	м	M	10-3	Мл
Мікро	мк		10-6	Мкм
Нано	н	N	10-9	Нм
Піко	п	P	10-12	пФ

Рис. 3.1 Приклад оформлення таблиці.

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

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

Посилання на таблицю роблять: за допомо­гою круглих дужок “...з побудованих кривих (таб. 2.8) видно...”; за допомогою виразів “...як видно з таб. 2.8...”, “...як показано у таб. 2.8...”. При посиланні на одне або декілька зображень, які позначені буквою, після номера рисунка ставлять кому і після неї букву (Як показано у таб. 2.2, б).

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

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

Посилання в тексті на порядковий номер формули роблять в дужках, наприклад: “у формулі (3)”, а при поділі документа на розділи “у формулі (1.3)”

Посилання на літературу можна оформлювати по-різному. Найбільш зручними є номерні посилання. Такі посилання містять тільки номер джерела (за списком), який беруть у прямі дужки - [28]. Якщо виникає потреба зробити посилання на певну сторін­ку, то пишуть - [28, с.45]. Посилання розміщують у тому місці, де це зручно за змістом При посиланні на роботи, які в списку стоять підряд, їх наводять через тире [6,24-28,32]. При наведенні в роботі цитат обов'язково посилаються на сторінку - [28, с.45].

При посиланні на багатотомні видання треба наводити том - [28,т.2], або том і сторінку - [28,т.2,с.24].

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

Приклад:

При вивченні даного явища М.М.Марчуком досліджено...

...отримано подібні результати (Марчук М.М., 1999).

R.Bowker (1967) і D. Devis з співробітниками (1978) показали, що...

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

Приклад:

… На площині задана, обмежена лініями

,

область …

Координати повинні одночасно задовольняти нерівності:

, .

Існує певний порядок застосування дужок у формулах: спочатку застосовують круглі (), потім прямі [] і фігурні {}.

Перенос формул дозволяється робити в першу чергу на знаках =,≈,<,>,≤,≥, в другу - на знаках -, +, ±; в третю — на знаку множення (×). Причому знаки повторюються на новому рядку.

Основний знак множення - крапка на середній лінії (•). Знак множення (×) застосовують тільки для переносу формули і для позначення векторного добутку (а×с) і розмірів (120×100×20). Знак множення не ставлять перед буквеними по­значеннями фізичних величин і між ними (), перед дужками, після них і між ними, між буквеними множниками в дужках, перед знаками інтегралу, радикалу, аргументами тригонометрич­них функцій. Знак множення ставлять між числовими множниками (12,2∙6∙68,9), для відокремлення множників від виразів, що відно­сяться до знаків логарифму, інтегралу тощо, між позначеннями одиниць фізичних величин.

Коефіцієнти в формулах пишуть попереду буквених вира­зів разом з ними

Приклад:

Правильно: Неправильно:

Примітка. У примітках до тексту і таблиць указують тільки довідкові дані та пояснення. Одна примітка не нумерується. Після слова “Примітка” ставлять крапку. Декілька приміток слід нумерувати по порядку арабськими цифрами з крапкою. Після слова “Примітки” ставлять двокрапку. Текст приміток допускається друкувати через один інтервал.

Додатки. Ілюстраційний матеріал, таблиці або текст допоміжного характеру допускається оформляти у вигляді додатків. Додатки оформляють як продовження даного документа на подальших сторінках або випускають у вигляді окремого документа. Кожен додаток повинен починатися з нової сторінки з вказуванням в правому верхньому кутку слова „ДОДАТОК" прописними буквами та мати тематичний заголовок, який записують симетрично тексту прописними буквами.

За наявності в документі більше одного додатку всі додатки нумерують арабськими цифрами (без знаку №), наприклад, ДОДАТОК 1. При випуску додатку окремим документом на титульному листі під виглядом документа слід вказувати слово “ДОДАТОК”, а за наявності декількох додатків указують також їх порядкові номери. Додатки, випущені у вигляді окремого документа, позначають як частину документа. При необхідності в такому додатку може бути поміщено “Зміст”.

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

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

Скорочення. У тексті проекту можна використовувати скорочення слів та термінів, що перераховані у ГОСТ 2.316-68. Скорочення, що не вказані у ньому, повинні бути приведені в переліку прийнятих скорочень

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

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

1. Алексенко А.Г., Шагурин И.И. Микросхемотехника. – М.: Радио и связь, 1982. – 416 ст.