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

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

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

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

рівень 1

рівень 2

рівень 3

2321.22

Структура програмного засобу

Структура програмного засобу

Структура програмного засобу у термінах програмних елементів (наприклад, програм, підпрограм, модулів, процедур, загальних модулів/процедур) у зв’язку з роз­в’язанням проблеми (див. № 2321.14). Цю структуру можна навести у графічній або текстовій формі

2321.23

Програмні блоки

Програмні блоки

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

2321.24

Операційна система

Операційна система

Операційна система

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

2321.25

Інші програмні засоби

Інші програмні засоби

Інші програмні засоби

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

2321.26

Мова

програмування

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

2321.27

Засоби розробляння/ виконання

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

2321.28

Початковий код

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

2321.29

Переліки трансляторів та компонуваль- ників

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

• роздрук скомпільованого, асембльованого або інтер­претованого програмного засобу, зокрема документи про помилки;

• роздрук символічних адрес та розподілу пам’яті;

• роздрук зворотного трасування адресних посилань;

• роздрук адресних посилань для завантажування

2321.30

Обсяг програмного

Обсяг програмного

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

2321.31

Витрати

Витрати

Витрати

Вказати витрати, пов’язані з одержанням програмного засобу, наприклад, ціни придбання/оренди, та експлуа- тувальні витрати (витрати на супровід). За потреби, треба оцінити витрати

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

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

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

рівень 1 1

рівень 2 1

рівень 3 1

2322

Організація даних

2322.1

Назва файла

Назва файла

Назва файла

Зазначання назв для ідентифікації файла, зокрема:

• назви, орієнтованої на застосування;

• імені, під яким операційна система зв’язує програмні засоби з файлом;

• у разі потреби, імені бази даних, яка зберігає дані

2322.2

Вміст файла

Вміст файла

Вміст файла

Орієнтований на застосування короткий опис вмісту та призначення

2322.3

Індекс файла

Індекс файла

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

2322.4

Взаємозв’язки

Взаємозв’язки

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

2322.5

Використання файла

Використання файла

Використання файла

Вказати на використання файла, як-от: — файл передавання;

— файл друку

2322.6

Організація файла

Організація файла

Організація даних, яку використовують, як от:

• послідовна;

• довільна з ключем або без нього;

• асоціативна;

• реляційна.

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

2322.7

Структура файла

Якщо файл має структуру, це треба описати; якщо ні, це треба зазначити (наряду із поясненням, «чому ні»)

2322.8

Середовище даних

Середовище даних

Деталі щодо виду та типу носія запису, що забезпечу­ють для файла

2322.9

Мітка файла

Опис або назви використовуваних міток (наприклад, для магнітних стрічок, жорстких дисків, компакт-дисків), якщо прийнятно — для кожного носія даних

2322.10

Метод зберігання

Для кожного середовища потрібно вказати метод збері­гання, як от:

• блокований/неблокований;

• стиснений/нестиснений

2322.11

Вимоги до пам’яті

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

2322.12

Код

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

2322.13

Тип доступу

Для кожного файла треба вказати застосовуваний ме­тод доступу

2322.14

Правила доступу

Захист

Захист

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

Вказати на залежні від часу або фізичні умови захисту файла

2322.15

2322.16

Строк зберігання/ дата закінчення строку

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

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

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

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

рівень 1

рівень 2

рівень 3

2322.17

Методи захисту

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

2322.18

Реорганізація

Реорганізація

Указання залежних від часу або зв’язаних із застосуванням умов для реорганізації та назва або опис використову­ваного методу

2322.19

Управління даними

Управління даними

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

2322.20

Організація супроводу

Адреса установи або ім’я фахівця, відповідального за актуальний вміст файла

2322.21

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

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

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

Назва групи даних, зокрема:

— назва, орієнтована на застосування;

— ім’я, яке використовують для локалізації записів файла

2322.22

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

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

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

Короткий опис вмісту та призначення, орієнтований на застосування

2322.23

Структура групи даних

Структура групи даних

Структура групи даних

Подання структури даних за допомогою переліку об’єктів даних, що показує їхні назви та положення у групі да­них. Для змінних груп даних треба зазначати довжину або розділювачі послідовності. Якщо для зберігання об’єкти даних стиснуто, треба описати або назвати метод

2322.24

Формат групи даних

Формат групи даних

Вказати, чи має група даних фіксовану або змінну дов­жину. Треба описати інші формати

2322.25

Довжина групи даних

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

2322.26

Код групи даних

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

2322.27

Правила доступу

Правила доступу

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

2322.28

Назва об’єкта

даних

Назва об’єкта

даних

Назва об’єкта

даних

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

• назва, орієнтована на застосування;

• назва, яку використовують для груп даних

2322.29

Вміст об’єкта даних

Вміст об’єкта даних

Вміст об’єкта даних

Короткий опис вмісту, орієнтований на застосування

2322.30

Тип об’єкта даних

Тип об’єкта даних

Тип об’єкта даних

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

2322.31

Довжина об’єкта даних

Довжина об’єкта даних

Вказати довжину об’єкта даних у стандартних одиницях (наприклад, байт або слово); для змінної довжини вка­зати максимально допустиму довжину

2322.32

Код об’єкта даних

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

2322.33

Діапазон значень

Діапазон значень

Вказати діапазон значень, дійсних для об’єкта даних

2322.34

Формат даних

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

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

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

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

рівень 1

рівень 2

рівень 3

2322.35

Набір символів

Вказати символи, допустимі для поля даних

2322.36

Зовнішнє подання

Вказати, яким чином повинно бути форматовано поле для зовнішнього подання, наприклад, шаблон друку

2322.37

Кодування/ декодування

Кодування/ декодування

Якщо для подання даних використовують коди, це треба описати у термінах, пов’язаних із значанням співвідно­шення «середовище/користувач».

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

2322.38

Правила доступу

Правила доступу

Опис або назва методу доступу з боку людини або про­грамного засобу

2322.39

Витрати

Витрати

Вказати витрати на адміністрування даних. За необхід­ності, треба оцінити витрати

233 Фізичні компоненти

Фізичними ресурсами є устатковання, матеріали та приміщення, необхідні для функціювання системи

2331

Пристрої обробляння даних

Пристрої обробляння даних — пристрої, що здійснюють основне обробляння даних, зокрема великі ЕОМ ко­лективного користування (мейнфрейми), сервери, персональні комп’ютери

2331.1

Назва

Назва

Назва

Вказати торговельну назву, наприклад, виробника/тип

2331.2

Розміри

Розміри

Вказати розміри та кількість пристроїв обробляння

2331.3

Опис

Точний опис пристроїв обробляння (наприклад, модель, пам’ять, рівень випуску/версії, можливості взаємодії з іншим устаткованням) та додаткове устатковання

2331.4

Конфігурація

Показати взаємозв’язки пристроїв обробляння та іншого устатковання, якщо можливо — у графічному вигляді, наприклад, схему конфігурації

2331.5

Витрати

Витрати

Витрати

Вказати витрати, пов’язані з одержанням пристроїв об­робляння, наприклад, ціна придбання/оренди, та експ- луатувальні витрати (витрати на супровід). За необхід­ності, треба оцінити витрати

2332

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

2332.1

Назва

Назва

Назва

Вказати тип (наприклад, принтер, допоміжну пам’ять) і торгівельну назву (виробник/тип)

2332.2

Робочі

характеристики

Робочі

характеристики

Вказати типові технічні характеристики та кількість оди­ниць устатковання

2332.3

Опис

Деталізований опис периферії, зокрема таке:

• метод запису;

• щільність символів;

• набір символів;

• код;

• довжина рядка або блока;

• ємність пам’яті;

• процедура передавання;

• швидкість передавання

2332.4

Передавання даних

Передавання даних

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

2332.5

Витрати

Витрати

Витрати

Вказати витрати, пов’язані з одержанням периферійного устатковання, наприклад, ціна придбання/оренди, та експлуатувальні витрати (витрати на супровід). За не­обхідності, треба оцінити витрати