---

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

Інформаційні технології

ДОКУМЕНТУВАННЯ ПРОГРАМ
ДОКУМЕНТАЦІЯ КОРИСТУВАЧА
(ISO/IEC 15910:1999, IDT)

ДСТУ ISO/IEC 15910:2012

В

БЗ № 1-2013/66

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

Київ
МІНЕКОНОМРОЗВИТКУ УКРАЇНИ
2013

ПЕРЕДМОВА

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

ПЕРЕКЛАД І НАУКОВО-ТЕХНІЧНЕ РЕДАГУВАННЯ: П. Андон, академік НАНУ; Л. Бабко;

В. Кириленко; В. Неумоін, канд. техн, наук

2 НАДАНО ЧИННОСТІ: наказ Мінекономрозвитку України від 28 листопада 2012 р. № 1356 з 2013-07-01

З Національний стандарт відповідає ISO/IEC 15910:1999 Information technology— Software user documentation process (Інформаційні технології. Процес документування програм кори­стувача)

Ступінь відповідності — ідентичний (IDT)

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

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

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

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

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

Мінекономрозвитку України, 201

3ЗМІСТ

с.

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

Вступ до ISO/IEC 15910:1999 IV

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

2. Відповідність 1

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

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

5. Керування якістю 6

6. Застосування 6

7. Ціль 6

8. Вимоги 6

   1. Процес документування 6

      1. Загальні положення 6

      2. Надання вихідних матеріалів 6

      3. План документування 8

      4. Переглядання 9

      5. Тестування придатності документації 11

      6. Розроблення документації із залученням інших компаній-субпідрядників 12

      7. Керування змінами та супровід документації 12

   2. Зміст специфікації стилю 12

      1. Загальні положення 12

      2. Стиль написання 13

      3. Паперова документація 13

      4. Електронна документація 16

Додаток А Перехресні посилання на ISO/IEC 12207 19

Додаток В Звернення до цього стандарту у контракті 19

Додаток С Приклад плану документування: документація користувача для системи керування плівками ABC 20

Додаток D Взаємозалежність між колом користувачів, завданнями, паперовою та діалоговою інформацією 23

Додаток Е Документування українською мовою 26

Додаток F Оцінювання 28

Додаток G Оцінювання плану документування ЗО

Додаток Н Приклад специфікації стилю ЗО

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

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

Цей стандарт є письмовий.переклад ISO/IEC 15910:1999 Information technology — Software user documentation process (Інформаційні технології. Документування програм. Процес докумен­тування програм користувача).

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

Стандарт містить вимоги, які відповідають чинному законодавству України.

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

• структурні елементи стандарту: «Титульний аркуш», «Передмову», «Національний вступ», першу сторінку, «Терміни та визначення понять» та «Бібліографічні дані» — оформле­но згідно з вимогами комплексу стандартів «Національна стандартизація»;

• вилучено «Предметний покажчик» через суттєву різницю між англійськими та українсь­кими термінами;

• назву додатка Е «Написання документів англійською мовою для перекладу» замінено на «Документування українською мовою»;

• з «Передмови» до ISO/IEC 15910:1999 у цей «Національний вступ» долучено те, що стосується цього стандарту;

• у розділі «Нормативні посилання» та «Бібліографії» наведено «Національні пояснення», виділені в тексті рамкою.

Додатки А—Н — довідкові.

У тексті стандарту містяться посилання на міжнародні стандарти, яким відповідають такі національні стандарти України:

ДСТУ ISO/IEC 6592:2004 Інформаційні технології. Настанови щодо документування комп’ютерних програм (ISO/IEC 6592:2000, MOD).

ДСТУ ISO/IEC 12119:2003 Інформаційні технології. Пакети програм. Тестування і вимоги до якості (ISO/IEC 12119:1994, IDT).

ДСТУ 3918-99 Інформаційні технології. Процеси життєвого циклу програмного забезпечення (ISO/IEC 12207:1995, IDT).

Копії міжнародних стандартів, на які є посилання у цьому стандарті, можна замовити в Головному фонді нормативних документів.

ВСТУП до ISO/IEC 15910:1999

Існує два види стандартів:

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

2. стандарти щодо процесів, які визначають спосіб, за яким створюються продукти.

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

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

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

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

Цей міжнародний стандарт було підготовлено об’єднаним технічним комітетом ISO/IEC JTC 1 на основі австралійського стандарту AS 4258:1994. Щодо відповідності між ISO/IEC 12207:1995 та цим міжнародним стандартом дивіться додаток А

.ДСТУISO/IEC 15910:2012

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

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

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

INFORMATION TECHNOLOGY

SOFTWARE USER DOCUMENTATION PROCESS

Чинний з 2013-07-01

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

Цей стандарт визначає процес створення документації для комп’ютерних програм, облашто- ваних інтерфейсом користувача. Така документація охоплює друковану документацію (наприклад, настанови та короткі довідкові картки), діалогову документацію, довідкові текстові та оперативні системи.

З точки зору документування як процесу цей стандарт відповідає стандарту ISO/IEC 12207:1995 «Інформаційні технології: Процеси життєвого циклу програмного забезпечення» як реалізація частини «6.1 Процес документування» стосовно документації користувача.

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

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

Цей стандарт застосовний не тільки до друкованої документації, а також і до екранів довідки, систем надання допомоги та оперативних текстових систем та систем надання допомоги. Дивись структурний елемент «Бібліографія».

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

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

2. ВІДПОВІДНІСТЬ

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

3. Видання офіційнеНОРМАТИВНІ ПОСИЛАННЯ

Наведені нижче нормативні документи містять положення, які через посилання в цьому тексті є положеннями цього стандарту. Для датованих посилань не застосовують публікації, які підлягають перегляду чи внесенню змін. Однак існують угоди, за якими в цьому стандарті рекомендовано застосовувати найпізніші видання наведених нижче нормативних документів Для недатованих посилань треба застосовувати найпізніші видання документа. Члени ISO та ІЕС ведуть реєстрацію чинних міжнародних стандартів.

ISO/IEC 216:1975 Writing paper and certain classes of printed matter — Trimmed sizes — A and В series.

НАЦІОНАЛЬНЕ ПОЯСНЕННЯ

ISO/IEC 216:1975 Папір для писання та деякі класи друкованих матеріалів. Формати обраної паперової смуги. Серії А та В.

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

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

Встановлені цим стандартом розміри паперу, А4: 297 мм х 210 мм та А5: 210 х 148 мм; див. ISO 216:1975

Організація, що замовляє або дістає систему, програмний продукт чи послугу від постачаль­ника. [ISO/IEC 12207:1995, визначення наведене в 3.1].

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

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

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

Спланований процес проведення інтерв'ю, а також аналізування результатів інтерв’ю та даних щодо персоналу.

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

Встановлені міжнародним стандартом розміри паперу: 176 мм х 250 мм; див. ISO 216:1975

Матеріали, що з’являються наприкінці книги або настанови на зразок індексу

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

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

Елементи, постачання яких замовнику обумовлено контрактом

Те саме, що елемент документації

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

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

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

Документ, що встановлює основні елементи проекту документування

Сторона, що готує документацію

Примітка. Термін розробник (як визначено в ISO/IEC 12207:1995, наведено у визначенні 3.31) тут не застосовний, тому що стосовно документації розробник програмного забезпечення часто виступає замовником документації, й використовування терміна «розробник» може вносити плутанину у цьому контексті. Отже вжито термін «постачаль­ник документації»