Информационная технология. Процесс создания документации пользователя программного средства - [19]

Графические элементы колонтитулов:
- верхний	Должен быть подчеркнут линией толщиной в 1 п с вертикальным пробелом в 1 п
- нижний	Должен быть надчеркнут линией толщиной в 1 п с вертикальным интервалом в 1 п
Надпись	Начинается с номера рисунка с двоеточием и текстом, например «Рисунок 1:…»
Гарнитуры шрифта, кегль и расположение надписей	Times Roman italics, кегль 10 п. Надписи должны быть расположены под рисунком
Таблицы	Ширина таблиц должна соответствовать формату текста основной части документа, а для их обрамления используют линии толщиной в 1 п
Гарнитуры шрифтов и минимальные кегли для таблиц	Times Roman, минимальный кегль в 8 п
Отчеты (сообщения)	Должны содержать правдоподобные (но не фактические) данные
Гарнитуры шрифтов и минимальные кегли для отчетов	Courier, минимальный кегль в 8 п
Компоновка отчетов	Должны быть представлены в горизонтальной (альбомной) компоновке без использования страниц-раскладок
Распечатки экранов:
- содержание	В каждом поле распечаток экранов должны быть представлены правдоподобные (но не фактические) данные
- оформление	Не должно быть горизонтальных или вертикальных искажений. Их ширина должна соответствовать формату набора
- частичные (т. е. представляющие часть экрана)	Должны быть в масштабе полноэкранных распечаток
Минимальная толщина линий, гарнитуры шрифтов и кегли для рисунков	0,5 п, шрифт Times Roman, минимальный кегль в 8 п
Рисунки	Рисунки и текст внутри них должны располагаться соответственно тексту основной части документа
Стиль текста уведомлений и предостережений	Стиль повествовательный, начинается со слова «Внимание:» или «Осторожно:»
Гарнитуры шрифтов, кегли и отступы для уведомлений и предостережений	Times Roman, кегль 24 п, расположение — по центру страницы, пробелы сверху и снизу, интервалы сверху и снизу — равные двум строкам
Справочный текст	Должны быть обеспечены возможности создания контекстных и расширенных справок, справок о клавишах, справок о справках и терминологических справок
Диалоговая документация	Должна содержать руководства для пользователя, командные справки, рекомендации по сообщениям и административную информацию
Сопутствующие материалы	Информация по одной тематике по возможности должна располагаться на одном экране
Подсветка и использование цвета	Цветовое оформление в диалоговой документации и справочных текстах не используют. Подсветку (более яркую цветовую тональность) используют только для заголовков
Диалоговая документация и справочный текст	Вверху отображаемого текста оставляют пустую строку (то есть между заголовком или верхом экрана и первой строкой текста). Формат текста — одноколонный
Заголовки диалоговой документации и справочного текста	Заголовки подсвечивают, используя более яркую цветовую тональность. Применяют только два уровня заголовков. Заголовки излагают в повествовательном стиле (см. 8.2.3.7.2). Сверху и снизу каждого заголовка оставляют пробел, равный одной строке
Текст основной части электронной документации	Должен быть выровнен по левой стороне, допускаются неровности по правому краю. Слева от каждой строки текста оставляют пробел, равный 20 символам
Правила навигации	Уровни расположения взаимосвязанной информации должны быть организованы и контролироваться так, чтобы пользователи могли легко возвращаться в исходную точку (пункт), содержание или указатель без блуждания в тексте документа
Клавиатура	Должны быть использованы следующие клавиши: F1 — для вызова справочной системы: Alt-Fl или Esc — для выхода из справочной системы. Никакие данные, введенные пользователем ранее, не должны быть потеряны при возврате из справочной системы к основному экрану

Н.3 Спецификация указателя

Н.3.1 Общие положения

Каждый документ, содержащий более 32 страниц, должен иметь указатель.

Примечание — Указатель должен охватывать все компоненты документа, включая вводные материалы, приложения, дополнения и рисунки.

Н.3.2 Качество

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

Примечание — Указатель должен занимать от 5 % (для учебных руководств) до 10 % (для справочных руководств) общего объема данного документа. Следует рассмотреть возможность использования профессиональных классификаторов.

Н.3.3 Состав (содержание) и организация указателя

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

Примечания

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

2 Для представления одинакового понятия должен использоваться один и тот же термин.

3 В указателе могут быть использованы подзаголовки, описывающие некоторые аспекты основного заголовка.

4 Заголовки указателя должны представлять основные понятия из конкретного документа. Для них следует использовать имена существительные, при необходимости дополняя их прилагательными, другими существительными или глаголами. В качестве заголовков могут быть взяты машинные команды, использованные в документации и представленные в виде глагола.