Oformlennya_tehnichnoyi_dokumentatsiyi

–поле 3 – позначення документа та зазначення виду носія даних. Вид носія даних зазначають тільки у разі виконання програмного документа на носії даних;

–поле 4 – обсяг документу (кількість аркушів);

–поле 5 – відмітка про облік та зберігання згідно ГОСТ 19.601 – 78 (в лівому нижньому куті на полі для підшивання);

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

1

2

20

3

4

5

6

210

297

Рисунок 6.1 – Макет заповнення титульного аркуша

6.3 Загальні вимоги до програмних документів

Загальні вимоги до оформлення програмних документів встановлює ГОСТ 19.105 – 78.

Програмний документ може бути представлений на різних типах носіїв даних і складається з таких умовних частин:

–титульна (по ГОСТ 19.104 – 78);

–інформаційна;

–основна.

Правила оформлення документа та його частин на кожному носії даних встановлюються стандартами ЕСПД на правила оформлення документів на відповідних носіях даних. Програмні документи

71

оформлюють на аркушах формату А4, як показано на рисунку 6.2. Допускається оформлення на аркушах формату А3.

25

20

1

2

10

297

3

15

210

1 – порядковий номер аркуша

2 – позначення документа

3 – текст документа

Рисунок6.2– Макетоформленняпрограмногодокумента

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

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

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

– позначення структурного елемента (номер розділу, підрозділу

тощо);

–найменуванняструктурногоелемента;

–адреса структурного елемента на носії даних (наприклад, номер сторінки, номер файлу тощо).

72

Правила позначення структурних елементів основної частини документа і їх адресації встановлюються стандартами ЕСПД на правила оформлення документів на відповідних носіях даних.

Склад і структура основної частини програмного документа встановлюються стандартами ЕСПД на відповідні документи.

6.4 Специфікація програми

Специфікація є основним програмним документом для компонентів, застосованих самостійно, а також для комплексів.

Вимоги до змісту та оформлення специфікації встановлює ГОСТ 19.202-78.

Інформаційну частину (анотацію та зміст) допускається в специфікацію не включати.

Форма специфікації програми наведена у додатку Л. Специфікація в загальному випадку повинна містити розділи:

–документація;

–комплекси;

–компоненти.

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

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

Коди виду документів наведені в ГОСТ 19.101 – 77.

Після кожного розділу специфікації необхідно залишати декілька вільних рядків для додаткових записів.

Графи специфікації заповнюють таким чином.

Вграфі "Позначення" указують:

–у розділі "Документація" – позначення занесених документів програми;

–у розділі "Комплекси" – позначення специфікацій комплексів, що входять в даний комплекс;

–у розділі "Компоненти" – позначення основних програмних документів компонентів.

В графі "Найменування» указують:

73

–у розділі "Документація" – найменування і вид документа для документів на дану програму, повне найменування програми, найменування і вид документа для документів, що запозичають;

–у розділах "Комплекси" і "Компоненти" – повне найменування програми, найменування і вид документа.

В графі "Примітка" – додаткові відомості, що відносяться до записаних в специфікації програм.

В графі "Позначення" запис проводиться в один рядок. В решті граф специфікації записи допускається проводити в декілька рядків.

6.5 Текст програми

Вимоги до змісту та оформлення програмного документу "Текст програми" встановлює ГОСТ 19.401 – 78.

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

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

–символічний запис на висхідній мові;

–символічний запис на проміжних мовах;

–символічне представлення машинних кодів тощо.

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

6.6 Опис програми

Склад та вимоги до змісту програмного документа "Опис програми" встановлює ГОСТ 19.402 – 78.

Складання інформаційної частини (анотації та змісту) є обо- в'язковим.

Опис програми повинен містити такі розділи:

–загальні відомості;

–функціональне призначення;

–опис логічної структури;

74

–технічні засоби, що використовуються;

–виклик та завантаження;

–вхідні дані;

–вихідні дані.

Залежно від особливостей програми допускається вводити додаткові розділи або об'єднувати окремі розділи.

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

–позначення та найменування програми;

–програмне забезпечення, необхідне для функціонування програ-

ми;

– мови програмування, на яких написана програма.

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

Врозділі "Опис логічної структури" повинні бути вказані:

–алгоритм програми;

–методи, що використовуються;

–структура програми з описом функцій складових частин та зв'язки між ними;

–зв'язки програми з іншими програмами.

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

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

Врозділі "Виклик та завантаження" повинні бути вказані:

–спосіб виклику програми з відповідного носія даних;

–вхідні точки в програму.

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

В розділі "Вхідні дані" повинні бути вказані:

– характер, організація та попередня підготовка вхідних да-

них;

–формат, опис та спосіб кодування вхідних даних. В розділі "Вихідні дані" повинні бути вказані:

–характер і організація вихідних даних;

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

прикладами, таблицями, схемами, графіками. В додаток до опису

75

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

6.7 Позначення програм та програмних документів

Структуру позначення програм та програмних документів для обчислювальних машин, комплексів і систем незалежно від їх призначення і області застосування встановлює ГОСТ 19.103 – 77.

Структура позначення програми та її програмного документа

– специфікації показана на рисунку 6.3.

Загальна		Код країни	А. В. ХХХХХ - ХХ
частина		Код організації-розробника
позначення
		Реєстраційний номер
		Номер видання (для програми)
		Номер редакції (для документа)

Рисунок6.3– Структурапозначенняпрограмитаїїпрограмного документа

На рисунку 6.4 показана структура позначення інших програмних документів.

А. В. ХХХХХ – ХХ ХХ ХХ - Х

Загальна частина позначення

Номер редакції документа

Код виду документа

Номер документа даного виду

Номер частини документа

Рисунок 6.4 – Структура позначення інших програмних документів

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

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

76

Номер видання програми або номер редакції документа присвоюють в порядку зростання від 01 до 99.

Код виду документа присвоюють відповідно до вимог ГОСТ 19.101 – 77:

–специфікація – код не присвоюють;

–текст програми – 12;

–опис програми – 13.

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

01до99.

Номер частини одного і того ж документа присвоюють в порядку зростання від 1 до 9.

6.8 Схеми алгоритмів, програм, даних та систем

Правила виконання схем алгоритмів, програм, даних та систем, а також умовні позначення (символи) в схемах встановлює ГОСТ 19.701

– 90.

77

				Додаток А
	Форми основних написів та додаткових граф до них
			ГОСТ 2. 104 – 2006
	А.1 Основний напис для креслень та схем (перший аркуш)
	Форма 1
7	10
				55		Літ.		Маса
Зм.	Арк. № докум. Підпис		Дата		5	5	5	17	18
				11?5 =
					Аркуш			Аркушів
						20
	23	15	10	185				50
	А.2 Основний напис для текстових конструкторських
	документів (перший або заголовний аркуш)
	Форма 2

Зм. Арк. № докум. Підпис Дата

Розроб.

Перев.

Н. контр.

Затв.

8?5 = 40

(2)

	Літ.			Аркуш	Аркушів
(1)
	15			15	20
				(9)

185

А.3 Основний напис для креслень, схем та текстових конструкторських документів (наступні аркуші)

Форма 2а

15

Зм. Арк.

№ докум.

Підп. Дата

185

(2)

7

Арк.

10

78

А.4 Додаткові графи до основнихнаписів

	5	7		5
35	і.дата		(26)	14
	Підп
		20	70
25	№ дубл.
	Інв.
	№

25		інв.
		Зам.
35		. і дата
		Підп
25		.№ правд.
		Інв

79

				Додаток Б
		Приклад оформлення заголовного аркуша ПЗ (реферату)
				10 min	3 min
				РЕФЕРАТ
		3 min
			Пояснювальна записка 78 арк., 8 рис., 3 табл.,
		5 джерел, 2 додатки. Графічна частина 3 аркуши.
			Об’єктом проектування є однофазний стабілі-
		затор змінної напруги. Мета роботи – розробка ста-
		білізатора.
			В процесі роботи проведені розробка та розра-
		хунок структурної та принципової схем стабілізато-
		ра, конструктивне опрацювання. Основні конструк-
		тивні та техніко – експлуатаційні показники: висока
		надійність, високі масогабаритні та енергетичні по-
		казники.
			Стабілізатор може застосовуватися для жи-
		влення побутової та промислової апаратури при не-
	Підп. і дата	значній зміні в часі навантаження, наприклад, для
		живлення телевізора.
			ОДНОФАЗНИЙ СТАБІЛІЗАТОР ЗМІННОЇ
	дубл.	НАПРУГИ, ШИРОТНО – ІМПУЛЬСНА МОДУЛЯЦІЯ
	інв.№ Інв.№				10 min
	і дата Зам.			ПК 6.050802.99.12.00.000 ПЗ
	Підп.	Зм. Арк.	№ докум.	Підп. Дата
		Розроб.	Єрмоленко	Стабілізатор	Літ. Аркуш	Аркушів
	.	Перев.	Паеранд
	правд				5	78
				змінної напруги
					ДонДТУ
	.№	Н.контр.
				Пояснювальна записка	ЕС – 09 – 2
	Інв	Затв.
					Формат А4
				80