Оформлення схем алгоритмів у програмній документації

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

При поданні алгоритму в схематичному вигляді використовуються спеціальні графічні символи. У стандарті ГОСТ 19.701-90 [10] визначені графічні символи, що призначені для використання в документації з обробки даних, і правила їх використання. У додатку Е подано частину правил з застосування символів, виконання схем та самі символи і їх призначення.

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

Рисунок 4 – Ініціалізація масиву ознак

Якщо схема повністю описує всю розробку, то вона подається як креслення на листах формату А4 з рамкою і основним написом за формою 2 на першому листі (див. рис. 5) и написами (рис. 6) – на наступних листах даного креслення .

Рисунок 5 – Приклад заповнення основного напису по формі 2

Рисунок 6 – Приклад заповнення напису на другому листі креслення

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

ОСНОВНІ ВИМОГИ ДО ОФОРМЛЕННЯ ТЕКСТОВИХ

ДОКУМЕНТІВ

Загальні вказівки

Згідно з вимогами стандарту СТВУЗ-ХПИ-3.01-2010 [11] текстові документи оформляються на аркушах формату А4 (210 х 297мм). За необхідності, (зображення схем, таблиць, рисунків) можна використовувати аркуші формату А3 (297 х 420мм), складені до формату А4. Документи виконуються за допомогою комп'ютерної техніки на одному боці аркуша білого паперу, українською мовою.

Розмір полів: верхнє – 20 мм, ліве – 25 мм, нижнє – 15 мм, праве – 10 мм.

Друк виконується шрифтом Times New Roman текстового редактора Word розміру 14 пунктів і полуторним міжрядковим інтервалом.

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

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

Нумерація сторінок

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

Побудова тексту

Написання текстових документів потрібно виконувати за вимогою ДСТУ 3008 –95 та стандарту СТВУЗ-ХПИ-3.01-2010.

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

Структурні елементи: «ЗМІСТ», «ПЕРЕЛІК УМОВНИХ ПОЗНАЧЕНЬ», «ВСТУП», «ВИСНОВОК», «СПИСОК ДЖЕРЕЛ ІНФОРМАЦІЇ» не нумерують, а їхні назви служать заголовками структурних елементів.

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

Нумерація підрозділу складається з номера розділу і порядкового номера підрозділу, розділених крапкою. Після номера підрозділу крапку не ставлять, наприклад: 1.1, 1.2 і т.д.

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

Підпункти тексту нумеруються окремо в межах кожного пункту. Їх номера складаються з номера розділу, порядкових номерів підрозділу, пункту і підпункту, розділених крапкою, наприклад: 2.1.1.1, 2.1.1.2 і т.д. Після номера підпункту крапку не ставлять.

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

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

Викладення тексту

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

Скорочення слів у тексті і підписах під ілюстраціями, як правило, не допускається. ГОСТ 2.316-81 визначив виключення, що дозволяють скорочувати окремі слова і словосполучення тексту. Основні виключення:

і т.п., і т.д., та ін., ін – тільки в кінці фрази;

див., табл., рис., стор., вип., журн., л. (лист), п. (пункт), розд. (розділ), ст. (стаття) – при посиланнях і виносках у суцільному тексті.

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

Оборот «від…до» у тексті варто уникати, його можна замінити через межу 5 – 10 або крапки 40...60. Абстрактні числа до 9 пишуться словами, понад 9 – цифрами (три криві; 10 розділів і т.д.).

Числа з розмірністю пишуться тільки цифрами, наприклад, 3 км, 5 грн і т.п. Дробові значення проставляються тільки цифрами – «1/4 ч».

Числові значення в тексті пишуться тільки від 0,1 до 1000. Для біль-ших значень вводять кратні одиниці (мега – 10⁶; гіга – 10⁹; тера – 10¹²; пета – 10¹⁵; еска – 10¹⁸), а для менших – часткові (санти – 10^-2; мілі – 10^-3; мікро – 10^-6; нано – 10^-9; піко – 10^-12;фемто – 10^-15; атто –10^-18).

Наприклад, 110 терабайт, 0,15 А.

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

Ілюстрації можуть бути розташовані по тексту документа відразу після першого посилання на них або на наступній сторінці. Крім того, вони можуть бути подані в додатках. Усі наведені в документі ілюстрації позначають словом «Рисунок» і нумерують арабськими цифрами в межах усього тексту (при їх невеликій кількості) або кожного розділу (при їх великій кількості). У випадку, коли ілюстрації нумерують у межах розділу, номер ілюстрації складається з номера розділу і порядкового номера ілюстрації, розділених крапкою. Номер ілюстрації в тексті вказують так: Рисунок 1 або Рисунок 2.1. (перша ілюстрація другого розділу).

При посиланні в тексті на ілюстрацію треба вказати її повний номер, наприклад, рис.1, рис.1.5. Повторні посилання на раніше згадані ілюстрації дають зі скороченням слова «дивися», наприклад, (див. рис.6.2). У випадку наявності в документі однієї ілюстрації вона в обов'язковому порядку підлягає нумерації з урахуванням викладених вище положень.

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

Наприклад: Рисунок 1.15 – Схема алгоритму програми

Побудова таблиць

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

Таблицю розташовують після першого згадування про неї або на наступній сторінці. У документі таблиці повинні відповідати вимогам ДСТУ 3008-95. За наявності в тексті декількох таблиць їх нумерують арабськими цифрами. Напис типу «Таблиця 2» або «Таблиця 1.2» (друга таблиця першого розділу) поміщають ліворуч над таблицею без лапок і крапки.

На всі таблиці повинні бути посилання в тексті, наприклад, (табл. 3). При повторному посиланні – (див. табл. 3). Якщо в тексті одна таблиця, то їй присвоюють номер відповідно до викладених вище вимог.

Таблиця в обов'язковому порядку повинна мати тематичний заголовок, який необхідно виконувати малими літерами (крім першої прописної) і поміщати над таблицею з лівої сторони разом зі словом Таблиця. Номер таблиці та її назва відокремлюються символом «тире».

Наприклад: Таблиця 2 – Призначення змінних

Написання формул

Формули набираються в редакторі формул Microsoft Equation 3.0 з такими настроюваннями: основний текст 14 пунктів, великий індекс – 20 пунктів, дрібний індекс 7 пунктів, великий символ – 20 пунктів. Латинські символи – похилі, грецькі й кирилиця – прямі символи.

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

При посиланні в тексті на формулу необхідно вказувати її повний номер у дужках, наприклад: “У формулі (1.2)”.

Оформлення приміток

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

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

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

Наприклад:

Примітки:

1 ...

2 ...

Поиск по сайту: