Страница 4: ДСТУ ISO/IEC 15910:2012. Інформаційні технології. Документування програм. Документація користувача (61132)

Це переглядання має за мету перевіряння коректної реалізації коментарів першої поперед­ньої версії.

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

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

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

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

Затвердженням коректури замовник визнає, що документ готовий для продукування.

План документування повинен встановлювати потрібний рівень тестування придатності.

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

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

Примітка 2. Під час визначення умов тестування треба повністю визначити чинний стандарт щодо придатності Сюди долучено визначення методу вимірювання та процес реєстрування.

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

Примітка 4. Тестування придатності може бути застосоване для вимірювання придатності, як визначено стандартом ISO/IEC 12119 1994 Інформаційні технології. Пакети програм Вимоги щодо якості та тестування

Умови тестування придатності мають бути повністю описані у плані документування, охоп­люючи таке:

1. момент(и) циклу розроблення, де має місце тестування;

2. цілі тестування;

3. міри, що повинні застосовуватись (наприклад, час відгуку завдання);

4. середовище тестування;

5. кількість та тип користувачів-учасників;

6. процес реєстрування результатів тестування та рекомендацій;

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

8. процес доведення результатів тестування всьому відповідному персоналу з розроблен­ня документації;

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

10. процес визначання потреби в подальшому тестуванні.

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

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

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

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

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

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

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

Існують чотири типи змін, які мають бути враховані в плані документування, як наведено нижче:

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

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

Примітка. Різницю між змінами, визначеними позиціями переліку (а) та (Ь), зазвичай, визначено терміносполукою «крайній термін».

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

4. Зміни до документації після публікації: зміни в опублікованій документації, які з’явили­ся, або через зміни у програмному забезпеченні, або через дефекти, віднайдені у документації.

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

1. процедури для об’єднання кожного з чотирьох типів змін у документі;

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

2. внесення назви документа та номера версії або дати та часу у верхній або нижній колон­титул документа;

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

4. додатково, деякі засоби, які дають змогу впевнитися в тому, що всі копії документа можна обновити після випуску;

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

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

8.2 Зміст специфікації стилю

Цей розділ встановлює зміст специфікації стилю.

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

Мову має бути визначено, за потреби — зі специфічними для країни варіантами (наприклад, французька (канадська)).

За потреби для мов має бути визначено словники правопису, додатково з переліком винятків.

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

Треба визначити настанову щодо граматики та стилю застосовування.

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

Розмір паперу має бути визначено.

Примітка. Під час вибирання розміру паперу треба врахувати таке:

1. Що А4, В5 та А5 — розміри паперу за міжнародним стандартом (див. 4.1 та 4.5)

2. У який спосіб буде зберігатися документ (деякі системи зберігання мають проблеми з розміром паперу).

3. Чи будуть застосовуватися дампи вмісту екранів (розмір А5 часто буває замалий для того, щоб уміщати дампи вмісту екранів настільки великі, щоб бути розбірливими).

4. Стандартний розмір паперу країни, в якій він буде використовуватися, якщо в документі передбачено фотоко­піювання.

5. Вимоги щодо переміщуваності паперу та робочого простору.

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

Має бути визначений одно- або двосторонній друк.

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

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

Примітка. Передбачуваний мінімум становить 300 точок на дюйм.

Має бути визначено відстань між полем друку та берегом для переплетення.

Має бути визначено відстань між полем друку та краєм паперу.

Має бути визначено колір чорнил.

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

Має бути визначено колір, вагу та якість паперу.

Примітка. Якщо потрібна певна паперова маса, це треба визначити.

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

Має бути визначено метод репродукування (друк, фотокопіювання, тощо), разом із мірами якості, яких треба дотримуватися.

Має бути визначено метод переплетення.

Має бути визначено схему нумерування сторінок.

Примітка 1. Кожну сторінку треба однозначно пронумерувати. Номери сторінок мають недвозначно означувати порядок, у якому розміщують сторінки.

Примітка 2. Під час переплетення з відривними сторінками треба розглянути схему нумерування сторінок, яка показує поточний номер частини/розділу, а також номер сторінки всередині частини/розділу: «1-1» «1-2» і т.д. (Це треба робити для того, щоб мати можливість долучати сторінки до середини тому без перенумеровування всіх наступних сторінок).

Примітка 3. Там, де не застосовно переплетення з відривними сторінками, треба розглянути використовування номерів сторінок «1», «2» і т. д. Через причини практичного характеру часто треба використовувати різні схеми нуме­рування сторінок для таблиць змісту («і», «іі» тощо), Однак треба бути обережними і не нумерувати кінцеві матеріали (покажчик тощо) у такий самий спосіб, як і титульні матеріали, тому що може виникнути плутанина між титульними та кінцевими матеріалами у разі випадіння сторінки та наміру відновити її на тому самому місці.

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

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