ГОССТАНДАРТ РОССИИ - Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА
- Название:Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА
- Автор:
- Жанр:
- Издательство:ИПК Издательство стандартов
- Год:2003
- Город:Москва
- ISBN:нет данных
- Рейтинг:
- Избранное:Добавить в избранное
-
Отзывы:
-
Ваша оценка:
ГОССТАНДАРТ РОССИИ - Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА краткое содержание
Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 15910-99 «Информационная технология. Процесс создания документации пользователя программного средства»
Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА - читать онлайн бесплатно полную версию (весь текст целиком)
Интервал:
Закладка:
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 Сопутствующие материалы
Должны быть установлены правила размещения материалов, связанных с электронной документацией, и их местоположение.
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».
Читать дальшеИнтервал:
Закладка: