---

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

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

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

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

1. титульної сторінки;

2. інформації стосовно гарантійних зобов’язань, авторських прав, відшкодування збитків та торгової марки;

3. таблиці змісту;

4. переліку ілюстрацій та таблиць;

5. додатків;

6. глосарію;

д) переліку абревіатур та скорочень;

h) покажчика.

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

Примітка. Немає потреби у визначанні всіх зазначених вище типів титульних та кінцевих матеріалів; лотребують визначення лише зміст та розмітка.

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

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

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

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

Примітка 1. У текстах, написаних романськими мовами, треба уникати макетів, довжина рядків яких перевищує 65 символів або становить менше ніж ЗО символів

Примітка 2. Для підраховування відповідної довжини рядка потрібно спершу встановити довжину рядка, яка дорівнює 5 см, та підрахувати, скільки символів (охоплюючи пробіли) припадає на десять рядків звичайного тексту (без розриву абзацу) за такої довжини рядка Розділити результат на 50, щоб отримати середню кількість символів на 1 см. Вирішити, скільки символів ви плануєте мати на рядок (це значення має бути в межах від 35 до 65) та поділити цю кількість на се­редню кількість символів на 1 см, щоб отримати потрібну довжину рядка у сантиметрах.

Там, де це прийнятно з точки зору мови, має бути визначено вирівнювання (наприклад, по лівому краю або по ширині).

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

Примітка. Треба уникати більше ніж трьох рівнів заголовків у межах тому Три рівні заголовків зазвичай достатньо

Там, де це прийнятно з точки зору мови, має бути визначено стиль тексту заголовків (наприклад «Стиль речення», «Усі прописні»),

Має бути визначено гарнітуру, кегль та горизонтальний і вертикальний інтервал для кож­ного рівня заголовка.

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

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

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

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

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

Має бути визначено графічні елементи (наприклад лінії, відтінок, піктограми), застосовні у верхніх та нижніх колонтитулах.

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

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

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

Має бути визначено гарнітуру та мінімальний розмір шрифту, що застосовують у таблицях

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

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

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

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

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

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

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

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

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

Має бути визначено правила щодо орієнтації ілюстрацій.

Там, де це прийнятно з точки зору мови, має бути визначено стиль тексту попереджень та застережень (наприклад «Стиль речення», «Всі прописні»).

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

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

8.2.4 Електронна документація

У стилі специфікації можна передбачати одне або більше з наведеного нижче:

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

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

3. Довідка щодо клавіатури: інформація стосовно використовування клавіатури, впорядко­вана за функціями, а не за іменами клавіш.

4. Довідка щодо довідки: інформація про застосовування довідкової системи.

5. Довідка щодо повідомлення: дії, які повинен або може виконати користувач у відповідь на конкретне повідомлення системи на зразок повідомлення про помилку.

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

д) Інтелектуальна довідка: підказка, що з'являється тоді, коли вона явно стосується сис­теми, з якою у користувача є проблеми. Підказка може бути, наприклад, «структурованою» таким чином, що на початку користувач отримує коротке довідкове повідомлення, але у разі повторю-

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

8.2.4.2 Типи діалогової документації

У стилі специфікації можна передбачати одне або більше з такого:

1. Настанова або довідник користувача: надає процедури щодо використовування продукту.

2. Довідник команд: (тільки для систем, керованих командами) надає синтаксис, результат дії та передбачуване застосовування кожної команди.

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

4. Інформація щодо адміністрування: інформація про конфігурацію, захист та (у разі при­йнятності) встановлення, необхідна системному адміністратору.

8.2.4.3 Макет

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

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

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

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

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

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

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

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

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

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

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

Для основного тексту має бути визначено такі елементи:

1. Вирівнювання (там, де це прийнятно з точки зору мови).

2. Інтервали.

Примітка. У текстах, написаних романськими мовами, треба уникати рядків, довжина яких перевищує 65 символів або становить менше ніж ЗО символів Для інтервалів між рядками тексту треба застосовувати відстань, що дорівнює як мінімум двом пікселям або ширині штриха, що становить 15 % від висоти символів, або будь-яку більшу відстань Цей проміжок не повинен використовуватися для маркерів наголосу або елементів малих символів, що зависають.

3. Мінімальна висота символів.

Примітка. У текстах, написаних романськими мовами, висота символів не повинна бути менше ніж 16 дугових хв і більше ніж 45 дугових хв Перевагу треба віддавати висоті символів у межах від 20 дугових хв до 22 дугових хв Дугові хвилини застосовують як міру висоти символів, що відображуються на екрані монітора; це — кут, який стягується символом в оці Він залежить не тільки від дійсної висоти символа на екрані, але й від типової відстані огляду екрана В таблиці 1 наведено співвідношення між висотою символа в дугових хвилинах та міліметрах на відстані огляду, що дорівнює одному метру Наприклад, із скороченням відстані висота у міліметрах пропорційно зменшується порівняно з табличними значеннями Для порівняння у таблиці також наведено еквівалент розміру друкованої крапки для шрифту Times RomanТаблиця 1 — Стягнутий кут та розмір крапки