ГОСТ Р ИСО/МЭК 15910-2002
8.2.3.14.1 Стиль текста
Должен бьпъ определен стиль текста уведомлений и предостережений для используемых вдоку
ментации языков (например. «Стиль основных предложении». «Все буквы заглавные»).
8.2.3.14.2 Гарнитуры, кегли шрифтов и отступы
Должны быть определены гарнитуры и кегли шрифтов, отступы по горизонтали и интервалы по
вертикали для уведомлений и предостережений.
8.2.3.14.3 Графические элементы, используемые взаголовках
Должны быть определены графические элементы (например, подчеркивание, раскраска, пикто
граммы), используемые в уведомлениях и предостережениях.
8.2.4Э л е к т р о н н а яд о к у м е н т а ц и я
8.2.4.1 Типы справочной шн/юрмиции
В спецификации стиля документации могут быть указаны один или несколько из следующих
типов справочной информации:
a) контекстная справка (context help) — информация о текущем поле, в котором находится
курсор или высвечена программа, включая ее необходимое или целевое (предметное) содержание, ее
назначение и потенциальное влияние на работу программного средства;
b
) расширенная справка (extended help) — информация о текущем экране или окне, включая ее
назначение и требуемый режим использования;
c) справка о клавишах (keys help) — информация о применении клавиатуры, функциональном
назначении клавиш и их переиаименовании (обозначении);
d) справка о справках (help to help) — информация об использовании справочной системы в
целом;
e) справка о сообщении (message help) — информация о том, что пользователь должен или может
сделать в отает на конкретные системные сообщения, например сообщения об ошибках;
0 терминологическая справка (reference phrase help) — определения конкретных элементов,
связей с конкретной тематикой и расшифровка обозначений и сокращений;
g) понятийная справка (intelligent help) — справочная информация, выдаваемая системой для
предупреждения пользователя об ошибках. Может быть структурирована, чтобы первоначально пользо
ватель получал краткое справочное сообщение, а при повторении той же ошибки —более подробное
сообщение, и наоборот, пользователь может получить развернутое сообщение при первой ошибке и
краткое —при ее повторении.
8.2.4.2 Типы диалоговой (оперативной) документации
Вспецификации стиля электронной документации могут быть указаны один или несколько из
следующих типов диалоговой документации:
a) руководства или рекомендации пользователя (userguide or reference) — описывают процедуры
по применению продукта;
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 Подсветка и использование цвета
Должны быть установлены правила использования в электронной документации подсветок выде
ляемых элементов и использование цветового оформления.
16