b) командные справки (command reference) — определяют синтаксис, результаты и целевое назначение каждой команды (только для команд управления системой);
c) рекомендации по сообщению (message reference) — определяют, что пользователь должен или может сделать в ответ на конкретные системные сообщения, например сообщения об ошибках;
d) административная информация (administration information) — информация о конфигурации и защите системы, а при необходимости — о ее инсталляции, предназначенная для администратора системы.
8.2.4.3 Оформление
8.2.4.3.1 Общее положение
Оформление (компоновка) информации в системах справочной и диалоговой (оперативной) документации во многом может определяться возможностями инструментальных средств, используемых при их создании.
8.2.4.3.2 Сопутствующие материалы
Должны быть установлены правила размещения материалов, связанных с электронной документацией, и их местоположение.
8.2.4.3.3 Подсветка и использование цвета
Должны быть установлены правила использования в электронной документации подсветок выделяемых элементов и использование цветового оформления.
Примечания
1 Использование подсветок и цветов для выделения элементов документации должно быть минимизировано, особенно в случае возможной путаницы между выделенным текстом и гипертекстовыми связями.
2 Цвета следует использовать осторожно, особенно при отсутствии уверенности в том, что тот же цвет не используется для уведомления о более важной информации. Это особенно важно при наличии у пользователей возможностей выбора различного цветового оформления экранов.
3 Для четкого выделения элементов и во избежание возникновения при этом проблем по возможности следует основные цвета (красный, зеленый и синий) использовать на фоне белого или черного.
4 Различные яркие цвета не следует использовать последовательно, так как это может привести к возникновению на экране трехмерных эффектов.
5 Обычно некоторые цвета имеют определенные смысловые значения (например, красный — «стой» или «опасно», зеленый — «продолжить» или «безопасно») и могут быть выбраны соответственно этому значению. Данный тип цветосочетания следует использовать осторожно, если пользователи могут выбирать различные цветовые оформления экранов.
6 Колористика экранов дисплеев является сложным вопросом и часто связана с недостаточной проект ной проработкой. Документаторам в этом случае следует обращаться за помощью к соответствующим специалистам.
8.2.4.3.4 Оформление диалоговой документации и справочного текста
Должны быть установлены правила оформления соответствующих текстов.
8.2.4.3.5 Заголовки
Должны быть установлены правила оформления соответствующих заголовков.
8.2.4.3.6 Текст основной части
Для текста основной части электронной документации должны быть определены следующие элементы:
a) выравнивание (для соответствующих языков);
b) отступы и интервалы.
Примечание — Для языков романской группы следует избегать строк длиной более 65 и менее 30 символов. Интервал между строками следует устанавливать не менее двух пикселей или 15 % от высоты символа, независимо от его величины. Это не распространяется на знаки ударения или выносные элементы строчных символов;
c) минимальная высота символа.
Примечание — Для языков романской группы высота символов должна быть не менее 16 и не более 45 угловых минут. Предпочтительной высотой символа являются 20–22 угловые минуты. Угловые минуты используются в качестве показателя высоты символа на видеодисплее; данный показатель отражает охват символа глазом. Он зависит не только от фактической высоты символа на экране, но также от нормального расстояния до экрана. В таблице 1 показано отношение между высотой символа в угловых минутах и миллиметрах на расстоянии в 1 м. Например, на более коротком расстоянии высота пропорционально уменьшается по сравнению с заданной в таблице. В таблице для сравнения также показано соответствующее число отображаемых точек для гарнитуры «Times Roman».
Таблица 1 — Угол обзора и число точек
| Угол обзора, угловые минуты | Высота, мм | Приблизительное число точек |
|---|---|---|
| 10 | 2,9 | 12 |
| 15 | 4,4 | 18 |
| 20 | 5,8 | 24 |
| 25 | 7,3 | 30 |
| 30 | 8,8 | 36 |
| 35 | 10,2 | 42 |
| 40 | 11,6 | 48 |
| 45 | 13,1 | 54 |
| 50 | 14,6 | 60 17 |
8.2.4.3.7 Навигация
Должны быть установлены правила навигации по электронной документации.
Примечания
1 Уровни связей информации в документации должны контролироваться, обеспечивая пользователю возможности возврата в исходный пункт, содержание или указатель без блуждания в документе.
2 Должны быть выработаны и применены правила структурирования документа. Например, количество связей в каждой информационной цепочке должно быть ограничено числом X. Значение X должно быть таким, чтобы пользователи имели соответствующие возможности для возврата к содержанию или перехода к другим структурным элементам документа. Уровни заголовков также могут быть взаимоувязаны с уровнями сложности документа (например, «В заголовках первого уровня представляется только общая информация»).
3 Проблемно ориентированная и общая информация должны быть выделены в отдельные разделы с входящими связями между ними, тем самым позволяя пользователю изучить конкретную задачу без непреднамеренного поиска в общих материалах, что может дезориентировать и отвлекать его.
4 Следует использовать графические материалы. Общая схема, отражающая основные разделы документа с гипертекстовыми связями между ними, дает пользователю ясное визуальное представление о структуре документа.
5 В начале документа должен быть раздел с рекомендациями пользователю, содержащий информацию по применению диалоговой документации. Данный раздел следует использовать для пояснения структуры документа и правил по его применению.
8.2.4.3.8 Использование клавиатуры
Должны быть определены правила использования специальных клавиш в диалоговой документации.
Примечания
1 Пользователь должен иметь возможность вызова справки, используя конкретную клавишу или комбинацию клавиш, в любой точке программы. Пользователь также должен иметь возможность вызова диалоговой документации с использованием единственной клавиши или комбинации клавиш.
2 В плане документирования должны быть определены условные наименования и функции всех специальных функциональных клавиш, используемых в системе диалоговой или справочной документации.