ДСТУ 4302:2004 Информационные технологии. Руководящие принципы документирования компьютерных программ (ISO/IEC 6592:2000 MOD)

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

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

(ISO/IEC 6592:2000, MOD)
ДСТУ 4302:2004

Відповідає офіційному тексту

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

ПЕРЕДМОВА

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

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

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

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

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

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

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

ЗМІСТ

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

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

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

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

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

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

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

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

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

4.3.2 Опис вмісту документа

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

4.4 Обмеження

4.5 Пристосування

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

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

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

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

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

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

Бібліографія

НАЦІОНАЛЬНИЙ ВСТУП

Цей стандарт є модифікована версія міжнародного стандарту 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) на ІПЗ (інженерія програмних засобів);

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

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

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

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

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

Копії стандартів, на які є посилання у цьому стандарті, можна отримати у Головному фонді нормативних документів З питань придбання офіційного видання звертайтесь до національного органу стандартизації
(ДП «УкрНДНЦ»).

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

ІНФОРМАЦІЙНІ ТЕХНОЛОГІЇ
НАСТАНОВИ ЩОДО ДОКУМЕНТУВАННЯ КОМП’ЮТЕРНИХ ПРОГРАМ

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

INFORMATION TECHNOLOGY
GUIDELINES FOR THE DOCUMENTATION OF COMPUTER-BASED APPLICATION SYSTEMS

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3.1 документ (document)

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

3.2 документація (documentation)

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

3.3 інформаційний елемент; піделемент (information item; sub-item)

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

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

3.4 профіль документації (documentation profile)

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

3.5 обумовлена інформація (conditional information)

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

3.6 необов’язкова інформація (optional information)

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

ДСТУ 4302:2004

БІБЛІОГРАФІЯ

ISO 9127:1988 Information processing systems — User documentation and cover information for consumer software packages.

ISO/IEC 12207:1995 Information technology — Software life cycle processes.