---

НАЦІОНАЛЬНИЙ СТАНДАРТ УКРАЇНИ

Інформаційні технології
НАСТАНОВИ ЩОДО ДОКУМЕНТУВАННЯ
КОМП’ЮТЕРНИХ ПРОГРАМ

(ISO/IEC 6592:2000, MOD)

Д

БЗ № 3-2004/127

СТУ 4302:2004

Видання офіційне

Київ
ДЕРЖСПОЖИВСТАНДАРТ УКРАЇНИ
200

5ПЕРЕДМОВА

1. РОЗРОБЛЕНО І ВНЕСЕНО: Технічний комітет зі стандартизації «Інформаційні технології» та Інститут програмних систем Національної Академії наук України

РОЗРОБНИКИ: П. Андон, чл.-кор. НАНУ; Л. Бабко; В. Неумоін, канд. техн, наук

2. НАДАНО ЧИННОСТІ: наказ Держспоживстандарту України від ЗО квітня 2004 р. № 85 з 2005-07-01

З Національний стандарт відповідає ISO/IEC 6592:2000 Information technology — Guidelines for the documentation ofcomputer-based application systems (Інформаційні технології. Настанови щодо документування комп’ютерних систем)

Ступінь відповідності — модифікований (MOD)

Переклад з англійської (en)

4 УВЕДЕНО ВПЕРШЕ

Право власності на цей документ належить державі.

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

Стосовно врегулювання прав власності треба звертатися до Держспоживстандарту України

Держспоживстандарт України, 2005

ЗМІСТ

с.

Національний вступ IV

1. Сфера застосування 1

2. Нормативні посилання 2

3. Терміни та визначення понять 2

4. Застосування стандарту 2

   1. Призначення документування З

   2. Принципи документуванння З

   3. Застосування стандарту до програмних систем З

      1. Загальне застосування З

      2. Опис вмісту документа 4

      3. Перегляд наявного вмісту документа 4

   4. Обмеження 4

   5. Пристосування 5

5. Метод документування 5

   1. Загальний вигляд опису інформаційних елементів 5

   2. Профіль документації 5

   3. Опис інформаційних елементів 5

   4. Детальний опис інформаційних елементів 11

Додаток А Приклад профілю документації 27

Бібліографія ЗОНАЦІОНАЛЬНИЙ ВСТУП

Цей стандарт є модифікована версія міжнародного стандарту ISO/IEC 6592:2000 Information technology — Guidelines for the documentation of computer-based application systems (Інформаційні технології. Настанови щодо документування комп’ютерних систем).

Відповідальний за цей стандарт — технічний комітет «Інформаційні технології» (ТК 20).

До стандарту внесено такі редакційні зміни:

• у назві стандарту слово «систем» замінено на «програм»;

• слова «цей міжнародний стандарт» замінено на «цей стандарт»;

• посилання на міжнародний стандарт ISO/IEC 122907:1995 Information technology — Software life cycle processes в основному тексті замінено на відповідний національний стандарт України ДСТУ 3918-1999 (ISO/IEC 122907:1995) Інформаційні технології. Процеси життєвого циклу про­грамного забезпечення;

• речення «У цьому міжнародному стандарті наведено керівні принципи документування інформаційних систем (ІС) для використовування у цій галузі. Цей міжнародний стандарт можна застосовувати до програмних засобів в ІС» (розділ 1) замінено на речення «У цьому стандарті наведено настанови щодо документування комп’ютерних програм. Цей стандарт можна засто­совувати для документування інформаційних систем (ІС)»;

• вираз «одержання необхідної прихильності сторін, залучених до життєвого циклу ІС для участі у процесі розробляння» (розділ 1) замінено на вираз «одержання необхідної прихильності сторін, залучених до життєвого циклу програмного забезпечення для участі у процесі розроб­ляння»;

• вираз «Цей міжнародний стандарт розроблено таким чином, що він застосовний до будь яких ІС» замінено на вираз «Цей стандарт розроблено таким чином, що він застосовний до будь- яких комп’ютерних програм»;

• вираз «Сприяти забезпеченню практичності та придатності до супроводу ІС» (підрозділ 4.1) замінено на вираз «Сприяти забезпеченню практичності та придатності до супроводу комп’ютерних програм»;

• замінено англомовні скорочення на україномовні, а саме:

IS (information systems) на ІС (інформаційні системи);

SE (software engineering) на ІПЗ (інженерія програмних засобів);

E (essential) на С (суттєвий);

C (conditional) на О (обумовлений);

O (optional) на Н (необов’язковий);

• познаки документів латинськими буквами замінено на познаки українськими буквами (ри­сунок 2, додаток А);

• структурні елементи цього стандарту: «Обкладинку», «Передмову», «Національний вступ» та «Бібліографічні дані»— оформлено згідно з вимогами національної стандартизації України.

Копії стандартів, на які є посилання у цьому стандарті, можна отримати у Головному фонді нормативних документів ДП «УкрНДНЦ».ДСТУ 4302:2004

НАЦІОНАЛЬНИЙ СТАНДАРТ УКРАЇНИ

ІНФОРМАЦІЙНІ ТЕХНОЛОГІЇ

НАСТАНОВИ ЩОДО ДОКУМЕНТУВАННЯ
КОМП’ЮТЕРНИХ ПРОГРАМ

ИНФОРМАЦИОННЫЕ ТЕХНОЛОГИИ

РУКОВОДЯЩИЕ ПРИНЦИПЫ ДОКУМЕНТИРОВАНИЯ
КОМПЬЮТЕРНЫХ ПРОГРАММ

INFORMATION TECHNOLOGY

GUIDELINES FOR THE DOCUMENTATION
OF COMPUTER-BASED APPLICATION SYSTEMS

Чинний від 2005-07-01

1. СФЕРА ЗАСТОСУВАННЯ

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

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

Керівні принципи, наведені у цьому стандарті, розроблено у таких цілях:

• одержання необхідної прихильності сторін, залучених до життєвого циклу програмного за­безпечення для участі у процесі розробляння;

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

• уможливлення виготовлення програмних документів співвідносно з життєвим циклом про­грамних засобів.

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

• наданню необхідної інформації;

• готуванню власної документації;

• оцінюванню часу та ресурсів, необхідних для виконання проекту;

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

• вибір досяжних цілей щодо системи;

• повніший та добре обґрунтований функційний проект;

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

• прийняттю рішень та інструктуванню персоналу протягом життєвого циклу програмних засобів.

Видання офіційне

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

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

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

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

2. НОРМАТИВНІ ПОСИЛАННЯ

Цей стандарт не має нормативних посилань. Посилання довідкового характеру наведено в Бібліографії.

2. ТЕРМІНИ ТА ВИЗНАЧЕННЯ ПОНЯТЬ

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

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

Сукупність одного або більше зв’язаних документів

Група елементів інформації.

Примітка. Піделемент є частиною інформаційного елемента

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

Інформація, яку постачають з кожним пакетом, якого вона стосується

Інформація, яку постачають на розсуд установи-виробника або торгової установи.

2. ЗАСТОСУВАННЯ СТАНДАРТУ

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

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

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

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

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

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

Документування має чотири основних призначення:

• Описати та зафіксувати інформацію про систему протягом її життєвого циклу.

• Сприяти забезпеченню практичності та придатності до супроводу комп’ютерних програм.

• Допомогти контролюванню процесів життєвого циклу.

• Надати інформацію про систему тим, хто її потребує.

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

Після ідентифікації всіх різних типів користувачів (цей стандарт посилається на них пізніше як на «кола користувачів») необхідно подумати про їхні інформаційні потреби. Різні кола кінце­вих користувачів мають різні інформаційні потреби, а різні кола розробників також мають різні потреби залежно від завдань, які вони виконують. Таким чином, інформацію треба перетворити у сукупність інформаційних елементів, що відповідають, за можливості, наведені у 5.4.

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

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

Для застосування цього стандарту треба визначити інформаційні вимоги користувачів. Ці вимоги треба визначати у профілі документації (5.2) з використанням опису інформаційних еле­ментів (5.3 та 5.4).

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

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