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

8.2.3.8 Верхние и нижние колонтитулы

Должно быть определено содержание заполнения верхних и нижних колонтитулов.

Примечание — Например, таковыми могут быть номера страниц, проставляемые на полях.

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

Примечание — Например, расположение номеров страниц на страницах каждого типа.

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

Должно быть определено содержимое надписей.

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

Должны быть определены правила оформления таблиц, например головки таблиц следует повторять при переходе на другую страницу.

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

Отчеты (сообщения) являются результатами работы прикладных программных средств, выдаваемые в печатном или экранном виде. Образцы отчетов обычно включают в документацию пользователя программного средства.

Могут быть установлены правила оформления и содержания отчетов.

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

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

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

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

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

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

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

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

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

Должен быть определен стиль текста уведомлений и предостережений для используемых в документации языков (например, «Стиль основных предложений», «Все буквы заглавные»).

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

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

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

a) контекстная справка (context help) — информация о текущем поле, в котором находится курсор или высвечена программа, включая ее необходимое или целевое (предметное) содержание, ее назначение и потенциальное влияние на работу программного средства;

b) расширенная справка (extended help) — информация о текущем экране или окне, включая ее назначение и требуемый режим использования;

c) справка о клавишах (keys help) — информация о применении клавиатуры, функциональном назначении клавиш и их перенаименовании (обозначении);

d) справка о справках (help to help) — информация об использовании справочной системы в целом;

e) справка о сообщении (message help) — информация о том, что пользователь должен или может сделать в ответ на конкретные системные сообщения, например сообщения об ошибках;

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

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

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

a) руководства или рекомендации пользователя (user guide or reference) — описывают процедуры по применению продукта;

b) командные справки (command reference) — определяют синтаксис, результаты и целевое назначение каждой команды (только для команд управления системой);

c) рекомендации по сообщению (message reference) — определяют, что пользователь должен или может сделать в ответ на конкретные системные сообщения, например сообщения об ошибках;

d) административная информация (administration information) — информация о конфигурации и защите системы, а при необходимости — о ее инсталляции, предназначенная для администратора системы.

Оформление (компоновка) информации в системах справочной и диалоговой (оперативной) документации во многом может определяться возможностями инструментальных средств, используемых при их создании.

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

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

Примечания

1 Использование подсветок и цветов для выделения элементов документации должно быть минимизировано, особенно в случае возможной путаницы между выделенным текстом и гипертекстовыми связями.

2 Цвета следует использовать осторожно, особенно при отсутствии уверенности в том, что тот же цвет не используется для уведомления о более важной информации. Это особенно важно при наличии у пользователей возможностей выбора различного цветового оформления экранов.

3 Для четкого выделения элементов и во избежание возникновения при этом проблем по возможности следует основные цвета (красный, зеленый и синий) использовать на фоне белого или черного.