Страница 4: ДСТУ 4302:2004. Інформаційні технології. Настанови щодо документування комп’ютерних програм (61990)

Номер елемента

Інформаційний елемент

Вміст інформаційного елемента

рівень 1

1 рівень 2

рівень 3

222

Дані

Точно описати всі дані, яких потребує система.

222.1

Назва даних

Назва даних

Назва даних

За потреби ввести назву орієнтованих на застосування даних, поділених на вхідні та вихідні дані

222.2

Вміст даних

Вміст даних

Вміст даних

Встановити фактичний вмістданих, в разі потреби, за ра­хунок іменування груп даних із посиланням на вимоги щодо захисту даних

222.3

Єрархія даних

Єрархія даних

Показати структуру даних, наприклад єрархію

222.4

Джерело/ приймач даних

Джерело/ приймач даних

Встановити джерела даних. Приймачі даних; за потреби, послатися на групи даних та окремі дані

222.5

Назва групи даних

Назва групи даних

Встановити орієнтовані на застосування назви груп даних

222.6

Вміст групи даних

Вміст групи даних

Встановити фактичний вміст груп даних, у разі потреби, за рахунок введення елементів даних із посиланням на вимоги щодо захисту даних

222.7

Використання груп даних

Використання груп даних

Зазначити використання груп даних стосовно проблем, наприклад, матрицю використання даних

222.8

Взаємозв’язки між даними

Навести взаємозв’язки між групами даних, елементами даних та завданнями, наприклад, матрицю вхід/вихід, таб­лицю рішень

222.9

Назва елемента даних

Навести орієнтовані на застосування назви окремих даних

222.10

Вміст елемента даних

Навести фактичний вміст, у разі потреби, значення окре­мих елементів даних, наприклад, константа із посилан­ням на вимоги щодо захисту даних

222.11

Використання елемента даних

Викласти, яким чином елементи даних використовують під час розв’язання, наприклад, параметрів, констант

222.12

Обсяги даних

Обсяги даних

Обсяги даних

Навести обсяг даних, що підлягають оброблянню

222.13

Частота надходження даних

Навести частоту та розподіл часу надходження вхідних даних із кількістю даних

222.14

Зростання даних

Навести очікуване зростання об’ємів даних в межах визначених часових рамок

Номер елемента

Інформаційний елемент

Вміст інформаційного елемента

рівень 1

рівень 2 1

рівень 3 1

223

Характеристики доступності

Характеристики доступності — переважно числові значення величин, що показують доступність системи, наприклад, частота, розподіл часу

223.1

Доступність системи

Доступність системи

Вказати час, або період часу (наприклад час дня), коли система повинна бути доступна для використання

223.2

Час відгуку

Вказати максимально допустимий час продукування систе­мою результатів, або часткових результатів, наприклад, відповідей під час діалогу

223.3

Розклади/ кінцеві терміни

Вказати часові рамки, в межах яких результати системи повинні бути доступними

224

Обмеження

До обмежень належать захищеність, таємність, безпека, практичність

224.1

Фізичні обмеження

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

224.2

Технічні обмеження

Вимоги, що базуються на наявній інформаційній техно­логії

225

Термінологія

225.1

Терміни

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

225.2

Дескриптори

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

226

Інформаційна модель

226.1

Методи

Методи

Короткий опис теорій та методів інформаційного моде­лювання, які використовують для задоволення вимог щодо системної інформації

226.2

Теоретичні засади

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

226.3

Словник бази даних/даних

Описати організацію структури об’єктів функційних даних для системи керування словником бази даних/даних

Номер елемента

Інформаційний елемент

Вміст інформаційного елемента

рівень 1 1

рівень 2

рівень 3

23 Компоненти системи

Опис компонент системи, які задовольняють вимоги, як заплановано, або наявних програмних засобів

231 Організація системи

2231

Структура

Структура

Позначити загальну структуру системи

2232

Інтерфейси

Інтерфейси

Описати інтерфейси з іншими системами та між компонентами системи

232 Програмні компоненти

2321

Програмна організація

2321.1

Назва програмного засобу

Назва програмного засобу

Назва програмного засобу

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

2321.2

Познаки альтернатив­ної назви

Познаки альтернатив­ної назви

Окрім назви програмного засобу можуть виділятися наз­ви альтернативних назв програмного засобу (що вико­ристовуються одночасно), наприклад, у зв’язку з від­мінними наборами або щодо різних застосувань. За по­треби різні частини документів можна стосувати різних альтернативних назв

2321.3

Версія

Версія

Версія

Окрім назви програмного засобу та познаки псевдоніму треба розрізняти декілька версій/варіантів програмно­го засобу або його псевдонімів. Документ повинен опи­сувати стан дійсної версії/варіанта

2321.4

Випуск

Випуск

Випуск

Назва випуску першої та поточної дійсної версії/ варіанта

2321.5

Дата випуску

Дата випуску

Дата випуску

Дата випуску першої та поточної дійсної версії/ варіанта

2321.6

Ім’я виклику

Ім’я виклику

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

2321.7

Вимоги щодо виклику

Умови коректного виклику програмного засобу, наприк­лад, дозволені комбінації параметрів, подій або тригерів

2321.8

Назва вхідних даних

Назва вхідних даних

Назва вхідних даних

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

2321.9

Ціль введення даних

Ціль введення даних

Опис цілей введення даних

2321.10

Деталізація введення

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

• розділювачі та їх функції;

• ключові слова для ідентифікації даних;

• пусті значення

Номер елемента

Інформаційний елемент

Вміст інформаційного елемента

рівень 1

рівень 2

рівень 3

2321.11

Назва вихідних даних

Назва вихідних даних

Назва вихідних даних

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

2321.12

Ціль виводу даних

Ціль виводу даних

Опис цілей виведення даних

2321.13

Деталізація виводу

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

2321.14

Дані, які передають

Опис даних, які передають без зміни

2321.15

Програмна функція

Програмна функція

Програмна функція

Узагальнений опис програмних функцій та інтерфейсів користувача

2321.16

Опис потоку даних

Опис потоку даних

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

2321.17

Програмна послідовність виконання

Програмна послідовність виконання

Треба описати внутрішню послідовність виконання, за потреби, на декількох рівнях; треба показати програмні модулі, процедури, умовні переходи, цикли та, в разі потреби, розділи синхронізації. Засоби опису містять таке:

• блок-схеми;

• таблиці рішень;

• структурні схеми.

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

2321.18

Алгоритми

Опис методу розв’язання та алгоритмів, показаний ра­зом з постановкою завдання та конструкцією програм­ного засобу. Назва методів, які застосовують у програм­ній конструкції

2321.19

Ключі для вико­ристовуваних кодів

Опис форматів та значень використовуваного коду. Треба показати систему конструкцій та допустимі зна­чення

2321.20

Обробляння помилок

Треба показати тести перевіряння на наявність помилок та вказати на наявні повідомлення щодо помилок та вислідних дій

2321.21

Режим роботи

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