---

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

Тире такої самої ширини, як прописна літера «н»

Примітки, зібрані наприкінці розділу або документа

Окрема сторінка, ширша за решту, зазвичай складена так, щоб не було потреби її обрізати

Матеріал, що повторюється внизу кожної сторінки (наприклад номер сторінки)

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

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

Матеріал, що повторюється вгорі кожної сторінки

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

Дивись Діалогова документальна система

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

Інформація, розроблена для визначеного кола користувачів задля визначеної цілі, що вико­ристовує визначений носій (наприклад книга, диск, картка короткої довідки, відеокасета) кон­кретного формату

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

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

Деталі друку, переплетення, виробництва та макетування паперової документації

Засоби, за допомогою яких користувач переміщується від однієї частини програмного засто­сування до іншої

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

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

Рядок тексту, розміщений сам по собі наприкінці сторінки

Та частина документації, що її подано в надрукованому вигляді

Найменший елемент екранного відображення; скорочене для терміносполуки «елемент зображення»

Міра вертикальної відстані; один міліметр уміщує 2,8 пункту (один дюйм уміщує приблиз­но 72 пункти)

Множина взаємопов’язаних дій, що перетворює входи на виходи [ISO/IEC 12207:1995, ви­значення 3.29]

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

Примітка. Також згадується як програмний продукт

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

Завершена копія паперового документа, подана замовнику для перегляду перед публікацією

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

Сторінка з тієї самої сторони (права або ліва), що й передня обкладинка

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

Інтегрована структура, що складається з одного або більшої кількості процесів, компонентів апаратного забезпечення, компонентів програмного забезпечення, засобів та персоналу, що забезпечує можливість задоволення встановленої потреби або цільової функції [ISO/IEC 12207:1995, визначення наведене у 3.32]

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

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

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

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

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

Формальний процес оцінювання придатності документації

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

Особа або організація, що використовує дієву систему для виконання заданої функції [ISO/IEC 12207:1995, визначення наведено в 3.19]. Дивись також Коло користувачів

Сторінка з протилежного боку (тобто права або ліва) від передньої обкладинки

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

Верхні, нижні, ліві або праві береги, що оточують текст

Рядок тексту сам по собі на початку сторінк

5. иКЕРУВАННЯ ЯКІСТЮ

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

Примітка. Навіть якщо стандарт з керування якістю не згадується у контракті, постачальники документації заохо­чуються до використовування системи керування якістю, яка підпорядковується відповідним стандартам із керування якістю Стосовно якості взагалі дивись також ISO/IEC 12119 1994 Information technology — Software packages — Quality requirements and testing (Інформаційні технологи Пакети програм Вимоги щодо якості та тестування)

6. ЗАСТОСУВАННЯ

Цей стандарт є єдиною реалізацією процесу документування, як визначено у ISO/IEC 12207:1995 Інформаційні технології. Процеси життєвого циклу програмного забезпечення і може бути пристосований до вимог щодо конкретних проектів (див. додаток В).

7. ЦІЛЬ

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

8. ВИМОГИ

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

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

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

У випадках, коли замовник визначив мінімум змісту документації (з цією ціллю, наприклад, можливе використовування стандартів ISO 6592 або ISO 9127:1988), цей факт треба врахову­вати постачальнику документації під час розроблення плану документування.

Замовник повинен забезпечити постачальнику документації доступ до:

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

2. робочої копії програмного забезпечення, якщо така наявна;

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

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

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

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

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

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

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

Рисунок 1 — Огляд процесу документування

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

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