Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА

Примечание — Распечатки экранов лучше понимаются, когда на каждой из них отражены реальные данные. В распечатках также должны быть использованы функциональные данные.

8.2.3.12.2 Оформление (компоновка)

Должны быть установлены общие правила оформления (компоновки) распечаток экранов.

8.2.3.12.3 Оформление частичных распечаток экранов

Должны быть установлены (при необходимости) правила оформления частичных (неполных) распечаток экранов.

8.2.3.13 Рисунки

8.2.3.13.1 Минимальная толщина линий, гарнитуры и кегли шрифтов

Должны быть установлены, используемые в рисунках гарнитуры и кегли шрифтов, а также минимальная толщина линий.

8.2.3.13.2 Расположение

Должны быть установлены правила расположения (ориентации) рисунков.

8.2.3.14 Уведомления и предостережения

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) — информация о том, что пользователь должен или может сделать в ответ на конкретные системные сообщения, например сообщения об ошибках;

f) терминологическая справка (reference phrase help) — определения конкретных элементов, связей с конкретной тематикой и расшифровка обозначений и сокращений;

g) понятийная справка (intelligent help) — справочная информация, выдаваемая системой для предупреждения пользователя об ошибках. Может быть структурирована, чтобы первоначально пользователь получал краткое справочное сообщение, а при повторении той же ошибки — более подробное сообщение, и наоборот, пользователь может получить развернутое сообщение при первой ошибке и краткое — при ее повторении.

8.2.4.2 Типы диалоговой (оперативной) документации

В спецификации стиля электронной документации могут быть указаны один или несколько из следующих типов диалоговой документации:

a) руководства или рекомендации пользователя (user guide 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 Сопутствующие материалы