Товары в корзине: 0 шт Оформить заказ
Стр. 1 

27 страниц

300.00 ₽

Купить Р 50.1.029-2001 — бумажный документ с голограммой и синими печатями. подробнее

Распространяем нормативную документацию с 1999 года. Пробиваем чеки, платим налоги, принимаем к оплате все законные формы платежей без дополнительных процентов. Наши клиенты защищены Законом. ООО "ЦНТИ Нормоконтроль"

Наши цены ниже, чем в других местах, потому что мы работаем напрямую с поставщиками документов.

Способы доставки

  • Срочная курьерская доставка (1-3 дня)
  • Курьерская доставка (7 дней)
  • Самовывоз из московского офиса
  • Почта РФ

Рекомендации устанавливают общие требования к содержанию, стилю и оформлению интерактивных электронных технических руководств (ИЭТР).

 Скачать PDF

Оглавление

1 Область применения

2 Определения

3 Сокращения

4 Общие положения

5 Требования к базам данных ИЭТР

6 Требования к содержанию ИЭТР

7 Требования к стилю ИЭТР

8 Требования к электронной системе отображения

9 Требования к специальным видам информации

 
Дата введения01.07.2002
Добавлен в базу01.09.2013
Актуализация01.01.2021

Этот документ находится в:

Организации:

02.07.2001УтвержденГосстандарт России256-ст
РазработанВНИИстандарт
РазработанТК 431 CALS-технологии
ИзданИПК Издательство стандартов2001 г.

Continuous acquisition and life-cycle support. Interactive electronic technical manuals. General requirements for content, style and user-interaction

Стр. 1
стр. 1
Стр. 2
стр. 2
Стр. 3
стр. 3
Стр. 4
стр. 4
Стр. 5
стр. 5
Стр. 6
стр. 6
Стр. 7
стр. 7
Стр. 8
стр. 8
Стр. 9
стр. 9
Стр. 10
стр. 10
Стр. 11
стр. 11
Стр. 12
стр. 12
Стр. 13
стр. 13
Стр. 14
стр. 14
Стр. 15
стр. 15
Стр. 16
стр. 16
Стр. 17
стр. 17
Стр. 18
стр. 18
Стр. 19
стр. 19
Стр. 20
стр. 20
Стр. 21
стр. 21
Стр. 22
стр. 22
Стр. 23
стр. 23
Стр. 24
стр. 24
Стр. 25
стр. 25
Стр. 26
стр. 26
Стр. 27
стр. 27

P 50.1.029-2001

РЕКОМЕНДАЦИИ ПО СТАНДАРТИЗАЦИИ

Информационные технологии поддержки жизненного

цикла продукции

ИНТЕРАКТИВНЫЕ ЭЛЕКТРОННЫЕ ТЕХНИЧЕСКИЕ РУКОВОДСТВА

Общие требования к содержанию, стилю и оформлению

Издание официальное

ГОССТАНДАРТ РОССИИ Москва

Предисловие

1    РАЗРАБОТАНЫ Научно-исследовательским центром CALS-технологий «Прикладная логистика» при участии Всероссийского научно-исследовательского института стандартизации (ВНИИстандарт)

ВНЕСЕНЫ Техническим комитетом по стандартизации ТК 431 «CALS-технологии»

2    ПРИНЯТЫ И ВВЕДЕНЫ В ДЕЙСТВИЕ Постановлением Госстандарта России от 2 июля 2001 г. № 256-ст

3    ВВЕДЕНЫ ВПЕРВЫЕ

© ИПК Издательство стандартов, 2001

Настоящие Рекомендации не могут быть полностью или частично воспроизведены, тиражированы и распространены в качестве официального издания без разрешения Госстандарта России

II

проводников, отображаемые вначале вместе с текстовым описанием в отдельном окне, должны затем быть упрощены до уровня того текста, вместе с которым они выводятся на экран. Однако если в ИЭТР имеется полная схема или диаграмма, то должна быть предусмотрена возможность доступа и к ней.

7.4.4.3 Функциональные технологические схемы

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

7.4.5    Графические изображения для указания местоположения

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

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

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

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

7.4.5.1    Последовательные графические изображения с указанием местоположения

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

7.4.5.2    Формат графических изображений с указанием местоположения

Минимальный размер изображения должен позволить пользователю быстро идентифицировать саму деталь и ее окружение. Чтобы точно показать нужную деталь, можно использовать выноску.

7.4.5.3    Выноски с экспликацией

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

-    выноска должна иметь стрелку, соединяющую обозначение с нужным местом на чертеже;

-    выноска выводится на экран только тогда, когда она соответствует операции, высвеченной в тексте на экране;

-    выноски должны быть привязаны к операциям или к отдельным фрагментам описания;

-    выноски и обозначения должны четко отличаться друг от друга и других графических изображений;

-    стрелки выносок должны быть по возможности прямыми, а не ломаными;

-    стрелки выносок по возможности не должны пересекать линий графических изображений;

-    если прямую линию от выноски провести нельзя, она должна иметь один излом под углом 45°. Толщина линии должна отличаться от толщины линий в основном графическом изображении;

-    допускается вместо обозначений деталей применять их названия, при условии что они соответствуют тексту;

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

7.4.6    Т р е б о в а н и я к стилю мультипликаций

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

7.5 Общие требования к стилю звуковой информации

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

8

P 50.1.029-2001

7.5.1    Требования к неречевым звуковым сигналам

Применение звуковых тональных сигналов должно ограничиваться только теми случаями, где их немедленное восприятие не связано с безопасностью персонала или работой оборудования. Частота тональных сигналов должна быть от 200 до 5000 Гц, предпочтительно 500—3000 Гц.

Если неречевой звуковой тональный сигнал используется совместно с выводимым на экран сообщением об ошибке или тревоге, то он должен состоять из одной частоты и должен предварять визуальное представление сообщения не более чем на 0,5 с.

7.5.2    Сочетаемость с окружающими условиями

Звуковой тональный сигнал должен быть совместим по своей природе с условиями, в которых предполагается использовать ИЭТР. Не допускается применение неречевых тональных сигналов, которые можно по ошибке принять за тональные сигналы, традиционно применяемые в рабочих условиях.

7.5.3    Требования к компьютерной речи и хранимой на электронных носителях записи речи

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

7.5.4    Произношение сокращений

Компьютерная или электронная речь должна быть закодирована таким образом, чтобы произносить полные слова при употреблении сокращений (например сокращение «с» должно произноситься словом «секунда»). Компьютерная речь должна быть закодирована на произношение отдельных букв сокращений многословных фраз без учета пунктуации, строчные они или заглавные, если это соответствует принятой практике. Если же такое произношение отдельных букв сокращения не принято, то нужно произносить каждое слово, представленное в сокращении, полностью (например ЮЮЗ следует произносить юго-юго-запад).

Любую аббревиатуру, используемую в контексте процедурной информации, которую невозможно или не принято произносить целым распознаваемым словом, в компьютерной речи необходимо кодировать одиночными буквами (например аббревиатура РФ должна произноситься Эр-Эф).

7.5.5    Произношение алфавитно-цифровых последовательностей

Любая последовательность цифр и букв в контексте процедурной информации, которая обычно

не произносится как единое целое, должна кодироваться на произношение отдельными буквами или буквами и цифрами (например обозначение детали А1А12А9 должно произноситься А-один-А-двенадцать-А-девять), а номер 78349015 нужно произносить как «семь-восемь-три-четыре-девять-ноль-один-пять».

8 Требования к электронной системе отображения

Программное обеспечение ЭСО должно обеспечивать взаимодействие пользователя с ИЭТР так, как это описано ниже. Функции, названия которых представлены заглавными буквами, следует понимать как логические или «виртуальные» функции, которые должны быть реализованы одним из технически возможных способов в рамках конкретной ЭСО. Например перемещение курсора и функция выбора могут быть реализованы при помощи «мыши», джойстика, светового пера, с клавиатуры, голосом. Функция ОК может быть реализована либо нажатием клавиши ENTER, либо клавиши «мыши». Настоящие рекомендации определяют логические функции пользователя, которые должны быть обеспечены ЭСО, но не оговаривают конкретные требования к клавиатуре или аппаратной части ЭСО. В таблице 1 приведен минимальный список виртуальных функций для общения пользователя с ЭСО и даны краткие определения этих функций.

Таблица 1 — Минимальный список логических функций управления ЭСО

Виртуальная функция

Определение

SELECT

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

POINTER SELECT

Передвинуть курсор, сделать выбор в точке текущего положения стрелки

OK

Конец ввода. Обработать данные или выполнить указанное действие

DELETE

Удалить элементы, указанные курсором

CANCEL

Прекратить текущую операцию без ввода данных

MENU

Включить меню и переключить его поле (если это предусмотрено в системе)

9

Окончание таблицы 1

Виртуальная функция

Определение

UP

Движение курсора вверх

DOWN

Движение курсора вниз

LEFT

Движение курсора влево

RIGHT

Движение курсора вправо

SCROLL UP

Переместить указатель прокрутки вверх (изображение вниз)

SCROLL DOWN

Переместить указатель прокрутки вниз (изображение вверх)

SCROLL LEFT

Переместить указатель прокрутки влево (изображение вправо)

SCROLL RIGHT

Переместить указатель прокрутки вправо (изображение влево)

CENTER

Переместить центр графического изображения на точку установки курсора после увеличения отображаемого графического изображения с помощью команды ZOOM-IN

ZOOM-IN

Увеличить воспроизводимое изображение

ZOOM-OUT

Уменьшить воспроизводимое изображение

SYSTEM HELP

Доступ к ПОМОЩИ в прикладной программе

CONTEXT HELP

Доступ к контекстно зависимой ПОМОЩИ

FULL SCREEN

Увеличить графику до полного размера поля пользователя в окне

QUIT

Выключить текущую прикладную программу, закрыть окна, связанные с этой программой

8.1    Средства взаимодействия пользователя с ЭСО

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

8.2    Курсор

Если информацию, представленную на экране, можно выделить, то ЭСО должна дать пользователю возможность осуществить это с помощью курсора. Курсор должен обозначать то положение (точку) на экране, где сфокусировано начало ввода. Курсор должен визуально выделяться на фоне остальной информации. Информация, которая может быть выделена, должна быть зрительно отличима от курсора и остальной информации, находящейся на экране, например при помощи рамки или границы вокруг объектов, которые могут быть выделены.

8.2.1    Выделение при помощи курсора

Выделение элемента информации при помощи курсора должно осуществляться следующим образом: позиционирование курсора на выделяемом элементе, включение функции SELECT с тем чтобы указать, что именно выделяется. Выделенный элемент автоматически подсвечивается. Таким образом ЭСО указывает пользователю, что выделение воспринято. Повторное выделение уже выделенного элемента отменяет предыдущее выделение. Пользователь должен иметь возможность выделить один элемент, ряд элементов, или дополнительные идущие не по порядку элементы. При завершении процесса выделения с помощью функции ОК, выделенные элементы автоматически активизируются. В случае, когда от пользователя требуется выбрать только один вариант, функция SELECT может активировать сделанный выбор без использования функции ОК.

8.2.2    Перемещение курсора

Для выделения элемента на экране дисплея необходимо перемещать или устанавливать курсор в нужное положение. Курсор должен передвигаться от выделяемой ячейки таблицы к другой ячейке, от выделяемого слова в тексте — к другому слову, от выделяемого элемента графики — к другому элементу. Функции LEFT, RIGHT, DOWN, UP должны дать возможность пользователю установить курсор в нужную точку. Если в системе не предусмотрено устройство свободного перемещения курсора, то вышеназванные функции должны обеспечить пользователю возможность точного позиционирования курсора. При этом степень точности позиционирования должна быть достаточной для установки курсора в любой зоне экрана, где может осуществляться операция выделения.

10

P 50.1.029-2001

8.2.3    Формы курсора

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

8.2.4    Стрелка

Если система имеет позиционирующее устройство типа «мыши», то такое устройство должно иметь указатель положения на экране (стрелку), а также функцию выделения (SELECT) стрелкой. Стрелка должна применяться для быстрого перемещения курсора по экрану. ЭСО должна обеспечивать пользователю возможность передвигать курсор и выделять элементы при помощи стрелки, путем наложения стрелки на изображенный объект, а также передвигать курсор и выделять объект при помощи функции выделения стрелкой (POINTER SELECT).

8.3 Окно

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

8.3.1 Структура окна

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

Заголовок окна

Рисунок 1 — Компоненты окна

8.3.2    Зона пользователя

Это та часть окна, в которой отображается информация ИЭТР. Она должна находиться внутри рамки окна и включать в себя одно или несколько вспомогательных окон для отображения текста, таблиц, графики или другой информации.

8.3.3    Т и т у л ь н а я строка и строка меню

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

8.3.4    Функции управления окном

Если для отображаемой информации нужно больше места, чем имеется в окне, пользователь

11

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

8.3.4.1 Полоса прокрутки

Е

Полосы вертикальной и горизонтальной прокрутки (см. рисунок 2) должны дать пользователю возможность прокручивать информацию вверх, вниз, вправо и влево для того, чтобы манипулировать отображаемым текстом, графическими изображениями, таблицами и т. д. Полосы прокрутки должны располагаться справа и (или) внизу окна данных и иметь стрелки в каждом углу. Полоса прокрутки должна иметь следующие элементы: область прокрутки — это фон полосы, который дает зрительное представление пользователю о длине участка прокрутки, которым он может пользоваться; кнопку-ползунок; стрелки, которые позволяют пользователю поэтапно прокручивать окно. Когда пользователь пользуется полосами прокрутки информации, то наблюдаемое движение информации будет противоположно направлению движения кнопки-ползунка.

* Заголовок окна

Полоса прокрутки


Полоса прокрутки

Рисунок 2 — Основное окно с функциями управления


Строка маню

8.3.4.2    Изменение размеров окна и его перемещение

Функция изменения размеров окна должна позволять пользователю отрегулировать местоположение и физический размер отдельного окна. Окна с изменяемыми размерами вначале выводятся на экран в размере, принятом в ИЭТР для данной ЭСО по умолчанию. В любой момент, в ходе отображения информации, пользователь должен иметь возможность изменить размер активного окна. Органы управления размером окна должны располагаться внутри рамки окна в одном или нескольких углах. Любое окно, размер которого может быть изменен, должно иметь отчетливую рамку или ясный индикатор, говорящий об этом. При изменении размеров окна количество отображаемой текстовой или графической информации увеличивается или уменьшается. Не допускается просто изменять масштаб изображения. Если изменять размер окна не разрешается, то граничная линия окна не отображается.

8.3.4.3    Кнопка меню окна

Кнопка меню окна должна быть расположена в верхнем левом углу окна. Она используется для включения меню окна.

8.3.5 Система меню

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

8.3.5.1 Ниспадающие меню

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

12

P 50.1.029-2001

8.3.5.2    Всплывающие меню

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

8.3.5.3    Выпадающие меню

Выпадающие меню должны использоваться для детализации ниспадающих и всплывающих меню. Они дают древовидную структуру, упрощающую представление сложных списков функций. Включение выпадающего меню должно осуществляться при помощи функции выделения внутри подменю. Если же выбранная функция имеет какие-либо подфункции, то появится другое подменю и пользователь получит дополнительные возможности для выбора. Чтобы облегчить пользование деревом выбора меню, оно не должно иметь более четырех уровней.

8.3.5.4    Представление меню

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

8.3.5.5    Ширина меню

Минимальная ширина меню должна быть не менее пяти букв. Колонки должны быть достаточно широкими, чтобы помещались все названия без необходимости их усечения. Если название слишком длинное и не помещается в зоне пользователя, то текст должен быть перенесен на следующую строку. Если все меню слишком велико и не может быть показано в зоне пользователя целиком, пользователю должно быть указано на существование «спрятанной» и не отражаемой на экране части меню.

8.3.5.6    Высота меню

Минимальная высота меню должна соответствовать высоте двух элементов (т. е. титульная строка и один элемент меню). Максимальная отображаемая высота меню равна высоте зоны пользователя. Шрифты, интервал между строк, разрешенные границы рамок меню между отдельными элементами должны соответствовать общим требованиям, предъявляемым к отображению текста.

8.3.5.7    Граница меню

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

8.3.5.8    Выделение подсветкой

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

8.3.5.9    Затемнение

ЭСО должна затемнять (путем окраски в серый цвет или снижением яркости) те пункты меню, которые не работают в данном контексте. В случаях, если все пункты меню не работают в каком-то контексте, то оно не должно отображаться.

8.3.5.10    Организация выбора

Имеющиеся возможности выбора должны быть сгруппированы функционально или по частоте их использования, в алфавитном порядке или по какому-то другому разумному принципу, очевидному для пользователя. Команды, изменяющие состояние системы или вводящие данные, которые в последствии нельзя отменить или удалить, по возможности не нужно располагать рядом с часто выбираемыми функциями.

8.3.5.11    Положение курсора в меню

Во всех меню курсор по умолчанию должен располагаться в одном и том же месте при каждом обращении к меню.

8.3.5.12    Строка меню

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

13

ENTER, TAB), должны быть перечислены в меню и быть доступны для пользователя в любое время. Нижний колонтитул может быть продублирован в строке меню.

8.3.5.13    Взаимодействие при помощи команд

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

8.3.5.14    Мнемоника команд меню

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

8.3.5.15    Цифровые величины

В качестве альтернативы мнемонике могут применяться цифровые величины. Если для осуществления функции выбора применяют цифровые величины, то в любом тексте меню они должны отделяться от текстового описания, по крайней мере, одним пробелом. Числовой код и описания для каждого пункта меню должны быть выровнены по левой границе соответствующей колонки перечня меню.

8.4 Диалоги и средства управления диалогами

Основным механизмом общения пользователя с ЭСО является диалог. Диалог реализуется при помощи окна диалога, которое может отображаться отдельно или накладываться на основное окно. В окне диалога должен иметься заголовок и одно или несколько графических средств управления. Всего может быть пять типов диалогов: предупреждение о тревоге, пустая строка для заполнения, одинарный/множественный выбор, список для выбора, композиционный диалог. Окна диалога должны появляться на экране в удобном и четко видном месте. Все диалоги должны иметь функцию ОК (за исключением информирующих об опасности) и функцию отмены CANCEL. Функции ОК и CANCEL завершают диалог. Построение и компоновка диалогов должны позволять пользователю легко отличить окно диалога от прочей информации на экране ЭСО.

8.4.1    Движение курсора в окне диалога

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

8.4.2    Представление данных в ходе диалога

Заголовки, используемые в окнах диалога, должны располагаться в непосредственной близости с соответствующими вариантами ответов на них (например рядом с кнопками). Когда заголовок диалога не содержит явного вопроса, заканчивающегося вопросительным знаком, то он должен завершаться двоеточием (:), что указывает на требование произвести выбор варианта ответа.

8.4.3    Диалоговые кнопки

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

8.4.3.1    Использование кнопок

При появлении на экране окна диалога пользователь должен либо отменить его, либо перейти в режим диалога путем наложения курсора на соответствующую кнопку с последующим включением функции выбора (SELECT). После осуществления выбора предпочтительного варианта пользователь должен иметь еще по крайней мере две кнопки, расположенные внизу окна диалога: ОК и CANCEL. CANCEL — это эквивалент функции CANCEL, которая используется для отмены диалога и удаления окна диалога с экрана, а кнопка ОК сообщает прикладной программе, что пользователь закончил диалог.

8.4.3.2    Представление кнопок

Общие кнопки (OK, CANCEL, HELP) должны находиться в нижней части окна диалога. Общие

14

P 50.1.029-2001

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

8.4.4    Сигнальные сообщения

8.4.4.1    Общие требования к сигнальной информации

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

8.4.4.2    Содержание сигнальной информации

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

8.4.5    Диалог с выбором

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

8.4.5.1    Одинарный выбор (круглые кнопки)

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

8.4.5.2    Множественный выбор (квадратные кнопки)

Диалоги с множественным выбором — это диалоги, из которых можно выбрать один или несколько предложенных вариантов. Множественный выбор должен осуществляться с помощью квадратных кнопок. Квадратные кнопки должны быть сгруппированы в списки взаимно не исключающих вариантов выбора. Пользователь должен иметь возможность отметить нужную кнопку (кнопки) знаком «+» или «>/» при помощи курсора или вводом цифры. Каждая кнопка должна иметь ясную и понятную форму (например квадрат) и визуальный индикатор осуществленного выбора.

8.4.5.3    Представление диалогов выбора

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

8.4.6    Диалоги с заполнением пустой строчки

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

8.4.7    Выбор из списка

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

8.4.8    Композиционный диалог

Комбинация из выше описанных диалогов может быть помещена в одно окно композиционного (составного) диалога.

8.5 Формат отображения информации и средства управления ЭСО

В 8.5.1—8.5.2 описаны стандартные типы данных (текст, графические изображения, таблицы), которые могут отображаться в зоне пользователя. При отображении стандартных типов данных в

15

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

8.5.1    Текст

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

8.5.1.1    Отображение текста

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

8.5.1.2    Шрифты

Все шрифты должны иметь заглавные и прописные буквы, числа и специальные знаки. Самый малый по высоте размер букв должен быть не менее 16 дуговых минут при нормальном расстоянии для чтения, либо высоту и ширину не менее 9 и 7 пикселей соответственно.

8.5.1.3    Расстояние между буквами

Расстояние между буквами в текстовой информации должно быть не менее 1/10 высоты буквы.

8.5.1.4    Размер строки

Размер пробела между словами в тексте должен быть равен одной (номинальной) ширине буквы. Пробел между строками должен составлять 0,33 высоты буквы, за исключением надстрочных и подстрочных индексов. В последнем случае расстояние между строками должно быть 0,15 от высоты буквы.

8.5.1.5    Текстовые окна

Ширина текстового поля должна составлять 30—60 знаков на строку. Там, где возможно, следует выдерживать ширину в 40 знаков.

8.5.1.6    Поля

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

8.5.1.7    Выравнивание

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

8.5.1.8    Переход на новую строку

Должен обеспечиваться переход на новую строку, с тем чтобы текст не выходил за пределы окна или правого поля. Строка может быть прервана только на полном слове. Прерывание внутри слова допускается только при четко выраженном переносе. При изменении размеров текста ЭСО должна обеспечивать автоматический переход на новую строку, с тем чтобы избежать выхода на правое поле. Если после изменения размера текст выходит за пределы видимого на экране окна, должна быть предусмотрена вертикальная колонка для его прокрутки.

8.5.1.9    Подсветка текста при выделении

ЭСО должна иметь возможность зрительно выделить выбранный текст (изменением цвета, подсветкой, изменением шрифта и т. п.).

8.5.1.10    Выделение текста

Пользователь должен иметь возможность выбрать выделенный текст путем установки курсора на него или вблизи выбранного текста с последующим включением функции SELECT.

8.5.1.11    Прокрутка

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

8.5.2 Графические изображения

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

8.5.2.1    Типы графических изображений

ЭСО должна обеспечивать представление двух типов графических изображений: статических и интерактивных. Статические изображения должны отображаться сразу во всех деталях и не предусматривают возможности манипуляций с изображением. Интерактивные изображения допускают возможность манипуляций с изображением, и ЭСО должна обеспечивать возможность таких манипуляций.

8.5.2.2    Масштаб

Графические изображения должны выводиться на экран в масштабе, при котором различимы

16

P 50.1.029-2001

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

8.5.2.3    Выделение фрагментов графического изображения

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

а)    выделение отдельного графического объекта, например детали;

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

8.5.2.4    Манипуляции с графическими изображениями

Если графическое изображение предназначено для просмотра с использованием функции прокрутки, пользователь должен иметь возможность пользоваться функциями SCROLL, ZOOM или FULL SCREEN (полный экран) для управления просмотром графики. Эти средства должны быть доступны пользователю всегда, когда размер графического изображения больше размера действующего окна.

8.5.2.5    Функция Zoom (изменение масштаба изображения)

ЭСО должна обеспечивать возможность увеличивать или уменьшать масштаб графического изображения. Увеличение масштаба должно быть обеспечено функцией ZOOM IN; уменьшение масштаба изображения должно производиться функцией ZOOM OUT.

8.5.2.6    Центрирование

ЭСО должен обеспечивать выполнение функции «Центрирование», которая перемещает центр графического изображения в точку, указанную текущим положением курсора, без какой-либо прокрутки.

8.5.2.7    Полный экран

Пользователь должен иметь возможность увеличить графическое изображение до полного размера поля пользователя в окне при помощи функции FULL SCREEN.

8.5.3 Отображение таблиц

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

8.5.3.1    Выравнивание

Список алфавитных данных должен быть выровнен по вертикали по левой стороне. Цифровые данные должны быть выровнены по десятичной запятой. При отсутствии десятичной запятой цифры выравнивают по правой стороне.

8.5.3.2    Расстояние между столбцами

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

8.5.3.3    Расстояние между строками

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

8.5.3.4    Подсветка

ЭСО должна обеспечивать подсветку выделенной информации в таблице. Таблицы, в которых содержатся активные выбираемые части, должны иметь подсвеченные участки. Весь подсвеченный участок должен быть чувствительным к функции выбора (SELECT). Все выбираемые участки выводятся на экран с визуально заметной подсветкой еще до операции выделения.

8.5.3.5    Выделение таблиц

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

8.5.3.6    Прокрутка таблиц

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

17

P 50.1.029-2001

Содержание

1    Область применения........................................................ 1

2    Определения.............................................................. 1

3    Сокращения.............................................................. 1

4    Общие положения.......................................................... 1

4.1    Интерактивные электронные технические руководства......................... 1

4.2    Взаимодействие между ИЭТР и электронной системой отображения............... 2

4.3    Общие требования к содержанию и стилю ИЭТР.............................. 2

5    Требования к базам данных ИЭТР............................................. 2

5.1    Текст............................................................... 2

5.2    Таблицы............................................................. 2

5.3    Графическая информация............................................... 3

5.4    Диалоги............................................................. 3

5.5    Ссылки для снижения избыточности объема информации....................... 3

5.6    Контекст............................................................ 3

6    Требования к содержанию ИЭТР.............................................. 3

6.1    Общие требования..................................................... 3

6.2    Вспомогательная информация, относящаяся к техническим аспектам.............. 3

6.3    Административная информация........................................... 3

6.4    Описание области применения........................................... 3

6.5    Содержание.......................................................... 4

6.6    Справочная система ИЭТР............................................... 4

6.7    Вспомогательные функции ИЭТР......................................... 4

6.8    Определения нестандартных терминов...................................... 4

6.9    Требования к мерам безопасности......................................... 4

7    Требования к стилю ИЭТР................................................... 5

7.1    Уровень детализации информации......................................... 5

7.2    Ясность изложения информации.......................................... 5

7.3    Общие требования к стилю текста......................................... 6

7.4    Общие требования к стилю графических    изображений.......................... 7

7.5    Общие требования к стилю звуковой    информации............................. 8

8    Требования к электронной системе отображения.................................. 9

8.1    Средства взаимодействия пользователя с ЭСО................................10

8.2    Курсор..............................................................10

8.3    Окно...............................................................11

8.4    Диалоги и средства управления диалогами...................................14

8.5    Формат отображения информации и средства управления ЭСО...................15

9    Требования к специальным видам информации...................................18

9.1    Процедурная информация...............................................18

9.2    Информация по отысканию неисправностей.................................20

III

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

8.5.4    Управление звуковой сигнализацией

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

8.5.5    Управление видеоинформацией

При выводе на экран видеоинформации, ЭСО должна обеспечивать выполнение следующих функций: начать демонстрацию, пауза, повтор, завершение демонстрации.

8.5.6    Управление воспроизведением мультипликаций

При выводе на экран мультипликаций, ЭСО должна обеспечивать выполнение следующих функций: начать демонстрацию, пауза, повтор, завершение демонстрации.

9 Требования к специальным видам информации

В дополнение к общим требованиям, к специальным видам информации предъявляются частные требования. К ним относятся:

а)    процедурно-технологическая информация;

б)    информация по поиску неисправностей;

в)    информация о деталях;

г)    описательная информация.

9.1    Процедурная информация

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

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

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

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

9.1.1    Т р е б о в а н и я к содержанию процедурно-технологической информации

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

9.1.2    Структуризация п ро це д у р н о - т е х н о л о г и ч е с к о й информации

Структурно вся процедурно-технологическая информация должна подразделяться на задачи,

подзадачи и операции. Задача — это совокупность подзадач и операций, направленных на достижение определенной цели. Каждая новая задача или подзадача должна начинаться выводом нового окна.

9.1.3    Т р е б о в а н и я к заголовкам и названиям

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

9.1.3.1    Название задачи

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

9.1.3.2    Заглавная строка подзадачи

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

18

РЕКОМЕНДАЦИИ ПО СТАНДАРТИЗАЦИИ

Информационные технологии поддержки жизненного цикла продукции

ИНТЕРАКТИВНЫЕ ЭЛЕКТРОННЫЕ ТЕХНИЧЕСКИЕ РУКОВОДСТВА

Общие требования к содержанию, стилю и оформлению

Continuous acquisition and life-cycle support. Interactive electronic technical manuals.

General requirements for content, style and user-interaction

Дата введения 2002—07—01

1    Область применения

Настоящие рекомендации устанавливают общие требования к содержанию, стилю и оформлению интерактивных электронных технических руководств (ИЭТР).

ИЭТР выполняется в цифровой форме и отображается конечному пользователю через электронную систему отображения (ЭСО), управляемую компьютером. В рекомендациях также содержатся требования к средствам интерактивного взаимодействия с пользователем и программному обеспечению ЭСО.

2    Определения

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

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

2.2    информационный объект: Смысловая и структурная единица технической информации.

2.3    электронная система отображения: Комплекс программно-технических средств для воспроизведения данных, содержащихся в интерактивном электронном техническом руководстве.

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

3    Сокращения

В настоящих рекомендациях используют следующие сокращения:

ИЭТР — интерактивное электронное техническое руководство;

CALS — Continuous Acquisition and Life-cycle Support;

ЭСО — электронная система отображения.

4    Общие положения

4.1 Интерактивные электронные технические руководства

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

ИЭТР включает в себя базу данных и ЭСО, предназначенную для визуализации данных и обеспечения интерактивного взаимодействия с пользователем.

База данных ИЭТР имеет структуру, позволяющую пользователю быстро получить доступ к нужной информации. Она может содержать текстовую и графическую информацию, а также данные в мультимедийной форме (аудио- и видеоданные).

ЭСО обеспечивает унифицированный для всех ИЭТР способ взаимодействия с пользователем и технику представления информации.

Издание официальное

ИЭТР предназначены для решения следующих задач:

-    обеспечения справочным материалом об устройстве и принципах работы изделия;

-    обучения персонала правилам эксплуатации, обслуживания и ремонта изделия;

-    обеспечения персонала справочными материалами, необходимыми для эксплуатации изделия, выполнения регламентных работ и ремонта изделия;

-    обеспечения информацией о технологии выполнения операций с изделием, потребности в необходимых инструментах и материалах, количестве и квалификации персонала;

-    диагностики оборудования и поиска неисправностей;

-    автоматизированного заказа материалов и запасных частей;

-    планирования и учета проведения регламентных работ;

-    обмена данными между потребителем и поставщиком.

4.2    Взаимодействие между ИЭТР и электронной системой отображения

База данных ИЭТР должна быть совместима с программным обеспечением ЭСО. ИЭТР не существует без соответствующей ему ЭСО. Соответственно, требования к формату данных или интерактивным средствам общения, изложенные в настоящих рекомендациях, должны быть отражены в спецификации на программное обеспечение ЭСО.

4.3    Общие требования к содержанию и стилю ИЭТР

4.3.1    Общие требования к содержанию ИЭТР

ИЭТР должно включать в себя: введение, оглавление, описание области применения, номер ИЭТР, дату выпуска ИЭТР, а также может содержать дополнительные разделы, требуемые заказчиком.

4.3.2    Т р е б о в а н и я, относящиеся к техническим функциям

Состав ИЭТР должен обеспечивать полноту, ясность изложения и эффективность применения.

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

4.3.3    Общие требования к стилю ИЭТР

Требования к «стилю» ИЭТР определяют:

а)    требования языкового характера (грамматика, синтаксис, применяемый словарь, критерии отбора технической терминологии, нумерация, сокращения);

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

4.3.4    Общие требования к интерактивному взаимодействию с пользователем

Общие требования к интерактивному взаимодействию ИЭТР с пользователем в ходе воспроизведения технической информации включают в себя:

а)    требования к функциям управления дисплеем (окна, курсор, прокрутка и т. д.);

б)    требования к функциям взаимодействия пользователя с ИЭТР, которые необходимы пользователю для того, чтобы получить интересующую информацию.

Данные требования должны быть учтены при создании ЭСО.

5 Требования к базам данных ИЭТР

База данных ИЭТР включает в себя совокупность информационных объектов различного типа. Информационные объекты могут быть простыми (примитивы) и составными. К примитивам относятся: текст, таблицы, графические элементы и диалоги. Каждый информационный объект может иметь набор атрибутов и связей с другими информационными объектами.

База данных ИЭТР должна отвечать требованиям, изложенным в 5.1—5.6.

5.1    Текст

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

5.2    Таблицы

Выводимые на экран таблицы должны быть представлены отдельными элементами (ячейками таблицы), каждый из которых характеризуется номерами столбца и строки. В свою очередь, элемент таблицы может быть ассоциирован (связан ссылкой) с другим элементом базы данных ИЭТР.

2

P 50.1.029-2001

5.3    Графическая информация

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

5.4    Диалоги

Диалоги предполагают выдачу пользователю информации через ЭСО и получение ответов. Диалоги должны быть организованы таким образом, чтобы выполнение последующих действий было бы возможным только после ввода ответа пользователя. Информация, касающаяся организации диалогов, должна бьггь представлена в базе данных ИЭТР таким образом, чтобы после вывода сообщения на экран и получения ответа можно было бы произвести анализ ответа, определить потребности пользователя и предоставить ему необходимые данные.

5.5    Ссылки для снижения избыточности объема информации

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

5.6    Контекст

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

6 Требования к содержанию ИЭТР

6.1    Общие требования

В 6.2—6.9 установлены общие требования к представлению вспомогательной информации, предупреждений, предостережений и замечаний.

6.2    Вспомогательная информация, относящаяся к техническим аспектам

Пользователь должен иметь доступ к дополнительной информации, относящейся к техническому содержанию ИЭТР. Функция «подсказка» должна позволять пользователю получить доступ к контекстно зависимой помощи, необходимой при выполнении определенных действий или в конкретных ситуациях. Эта функция должна также позволять ему получить описательную информацию с дальнейшими разъяснениями отдельных технических моментов, с объяснением специальных терминов или для получения более полного объяснения процесса, кратко изложенного в самой технической информации. Функция «подсказки» должна быть предусмотрена для всех разделов ИЭТР.

6.3    Административная информация

Все ИЭТР должны содержать следующую административную информацию, которую пользователь может вывести на отображающее устройство по своему выбору:

-    название ИЭТР, присвоенный ему номер и версию документа (если необходимо);

-    уровень доступа к ИЭТР, который должен демонстрироваться пользователю при его первом обращении к ИЭТР;

-    дата выпуска, дата последнего и всех предыдущих внесенных в ИЭТР изменений;

-    номер редакции ИЭТР (если необходимо);

-    организация-разработчик;

-    организация, осуществлявшая технический контроль ИЭТР;

-    организация, ответственная за управление конфигурацией оборудования или системы;

-    адрес для сообщений с замечаниями и предложениями;

-    порядок получения дополнительных копий и их формат;

-    список рассылки;

-    уведомление об ограничении на экспорт (если необходимо);

-    перечень документов и технических руководств, на которые сделаны ссылки в ИЭТР, но которые не вошли в состав ИЭТР;

-    пояснения, касающиеся изделия, к которому относится поставляемое ИЭТР, вариантов его конфигурации и их идентификации.

6.4    Описание области применения

ИЭТР должно быть снабжено четко сформулированным описанием области применения,

3

детально идентифицирующим конкретную систему, оборудование или компоненты, к которым оно относится, указывает уровень обслуживания, для которого оно предназначено. Эти сведения должны даваться дополнительно к любой информации, выводимой посредством ЭСО, и они должны ясно указывать, к какому классу изделий, перечню моделей изделий, серийным номерам изделий относится ИЭТР.

6.5    Содержание

ИЭТР должно иметь содержание с указаниями для пользователя, облегчающими поиск нужной информации. Если ИЭТР представляет собой руководство по технологии ремонта, построенное по процедурному принципу, то в него необходимо включить перечень всех рассмотренных задач по ремонту оборудования. Содержание должно быть организовано в соответствии с логической последовательностью работ и включать в себя необходимые ветви переходов. Пользователь должен иметь возможность доступа к нужной ему информации непосредственно из меню в содержании.

6.6    Справочная система ИЭТР

В дополнение к помощи, предусмотренной для технической информации, пользователь должен иметь информационную помощь по пользованию ИЭТР и ЭСО. Должно быть указано, как получить доступ к конкретной информации, как пользоваться функциями системы отображения.

6.7    Вспомогательные функции ИЭТР

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

6.8    Определения нестандартных терминов

В ИЭТР должен быть включен глоссарий со всеми акронимами, сокращениями и нестандартными терминами. Доступ к глоссарию должен обеспечиваться в любой момент в ходе использования ИЭТР.

6.9    Требования к мерам безопасности

6.9.1    Предостережения, предупреждения и примечания

Техническая информация должна дополняться предостережениями, предупреждениями и

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

а)    составлять единое целое с материалом, к которому они относятся;

б)    со всей очевидностью показывать пользователю, что речь идет о предостережении или предупреждении, для чего необходимо включить соответствующий графический символ, слово ПРЕДУПРЕЖДЕНИЕ или другой четко заметный знак;

в)    содержать в себе всю необходимую информацию о том, что нужно сделать, чтобы избежать или снизить степень опасности;

г)    сообщения такого типа должны легко читаться и быть понятными в рабочей обстановке.

6.9.2    Перечень необходимых мер безопасности

ИЭТР должно иметь отдельный раздел, содержащий сводный перечень рекомендаций по обеспечению безопасности. Если ИЭТР содержит несколько разделов, применяемых независимо друг от друга, каждый из них должен иметь свой подраздел по мерам безопасности.

6.9.3    Текст предупреждений и предостережений

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

а)    конкретный характер опасности;

б)    какие шаги нужно предпринять, чтобы избежать или минимизировать опасность;

в)    месторасположение источника опасности;

г)    последствия несоблюдения предупреждения.

P 50.1.029-2001

6.9.4    Текст примечаний

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

6.9.5    Расположение предупреждений, предостережений и примечаний

Расположение предупреждения должно определяться логикой изложения и соответствовать

следующим правилам:

а)    предостережения и предупреждения должны быть непосредственно связаны и логически предшествовать тексту той процедуры или операции, к которой они относятся;

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

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

6.9.6    Предупреждения об угрозе здоровью

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

7 Требования к стилю ИЭТР

ИЭТР должны разрабатываться в соответствии с общими требованиями к стилю, изложенными в данном разделе. Эти требования распространяются на язык текстовой информации и на графику, дополняющую текстовую информацию.

7.1    Уровень детализации информации

Техническая информация должна содержать всю информацию, необходимую для того, чтобы пользователь мог выполнить поставленную задачу или полностью понять описание. Уровень детализации описаний определяет заказчик. ИЭТР должно содержать достаточное количество информации, чтобы пользователь мог выполнить предусмотренное техническое обслуживание без ошибок и потери времени из-за недостатка информации. Если заказчик не оговаривает иного, то при выполнении общепринятых процедур (например «...открыть щиток доступа к...») последовательность шагов не регламентируется. Если же процедура является специальной или требует применения специального инструмента или оборудования, то такая процедура должна быть описана и представлена по шагам, так чтобы нельзя было перейти к следующему шагу, не выполнив предыдущего.

7.2    Ясность изложения информации

Чтобы обеспечить ясность изложения информации, содержащейся в ИЭТР, необходимо соблюдать следующие принципы при его разработке:

-    важную значимую информацию давать в виде описательного текста, отвечающего на вопросы:

1)    что это такое (система, компонент), какими особыми свойствами обладает?,

2)    какие функции выполняет? Что подается на вход и получается на выходе? Как взаимодействует с другими системами?,

3)    как выполняются функции? (дать пояснения принципа действия),

4)    в какой момент общей работы всего комплекса вступает в действие эта система?,

5)    где расположен интересующий нас блок или деталь?;

-    когда описательный текст приводится совместно с графикой, для сокращения текста необходимо:

1)    устранить все междометия,

2)    начинать предложения с переходных глаголов,

3)    по мере возможности применять повелительное наклонение;

-    если нужно указать время, предложение должно начинаться со слова «когда» (например когда напряжение питания стабилизируется) и т. д.;

-    не рекомендуется использовать сложноподчиненные и сложносочиненные предложения.

5

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

Генератор частоты биений имеет три блока:

(1) ...

(2) ...

(3) ...

-    средняя длина предложения не должна превышать 20 слов. Средний абзац не должен превышать шесть предложений. Каждый абзац по возможности должен иметь заглавное или основное предложение, весь материал в абзаце должен быть по этой теме;

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

-    описательный текст следует давать в логической последовательности операций выполнения работы. При необходимости допускается включение обобщенных подзаголовков к разделам;

-    описательный текст должен быть выдержан в единой терминологии, едином стиле и формате во всем ИЭТР.

7.3 Общие требования к стилю текста

Стиль текста ИЭТР должен отвечать следующим требованиям.

7.3.1    Языковые особенности

Изложение должно быть фактическим, сжатым, ясным, сопровождаться примерами, понятными подготовленному опытному работнику. ИЭТР не должно содержать никакой излишней информации, помимо сугубо нужной для выполнения задачи. Дополнительная информация должна быть доступной через функцию «подсказка».

7.3.2    Н о м е н к л а т у р а названий и обозначений

Номенклатура наименований узлов, деталей и т. д. должна соответствовать номенклатуре, принятой в соответствующих документах системы материально-технического обеспечения или других документах или спецификациях по обслуживанию оборудования. Принятые сокращения, акронимы допускаются только после того, как вначале в ИЭТР приведено их официальное определение.

7.3.3    Номенклатура названий инструмента и испытательного оборудования

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

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

7.3.4    Сокращения

Следует применять только общепринятые сокращения. Применяемые сокращения обязательно должны быть включены в глоссарий ИЭТР.

7.3.5    Единицы измерения

Единицы измерения должны быть приведены в Международной системе единиц (СИ), одни и те же по всему тексту. Отклонения следует оговаривать особо. Если на приборах даны другие единицы, эквивалент единиц СИ необходимо дать в скобках. Единицы измерений должны использоваться в следующих целях:

а)    для показаний температуры, в соответствии с маркировкой на оборудовании. Если использованы не градусы Цельсия, их эквивалент нужно дать в скобках. Общие указания, такие как комнатная температура и т. п. тоже следует приводить в градусах Цельсия;

б)    скорость, расстояние и т. п. приводят так, как они указаны на оборудовании. Если это не единицы СИ, их перевод необходимо дать в скобках. По требованию заказчика перевод в другие единицы измерения может быть дан в скобках после приведенных единиц СИ;

6

P 50.1.029-2001

в) положения выключателей и маркировка на панелях приводятся в таком виде, как это изображено на оборудовании. Буквы греческого алфавита (Q) и математические символы (оо), если они не поддерживаются ЭСО, могут передаваться словами («омы», «бесконечность»).

7.3.6    Численные выражения допусков

Для всех числовых измерений, которые имеют допуски, нужно указывать оптимальное значение и соответствующие допуски [например (15±1,25) В постоянного тока или (15+4/—2) В переменного тока]. Допуски не разрешается выражать в процентах. Величина допусков указывается до десятичного знака, считываемого на соответствующем приборе.

7.3.7    Словарь

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

7.4 Общие требования к стилю графических изображений

Графические изображения для ИЭТР должны разрабатываться с учетом общих требований к стилю как отдельных графических изображений, так и тексто-графических блоков. Требования к качеству и степени детальности графических изображений, изложенные в 7.4.1—7.4.8, предусматривают воспроизведение изображения на самых простых устройствах (с наименьшим экраном), предназначенных для применения в составе ЭСО.

7.4.1    Порядок отображения графических изображений

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

7.4.2    Д е т а л и з а ц и я графического изображения

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

7.4.2.1    Масштаб графического изображения

Графическое изображение должно выполняться в таком масштабе, чтобы все различимые детали имели истинную форму. Ширина линии выбирается исходя из четкости ее изображения на наименьшем из возможных дисплеев ЭСО.

7.4.2.2    Уровень детальности

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

7.4.3    Угол зрения

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

7.4.4    Типы графических изображений

Графические изображения, применяемые в ИЭТР, могут включать: сборочные чертежи, изображения в изометрии, перспективе и ортогональной проекции. По согласованию с заказчиком допускаются и другие виды графических изображений.

7.4.4.1    Чертежи

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

7.4.4.2    Монтажные схемы и диаграммы

При отсутствии особых требований заказчика, монтажные схемы, диаграммы и перечни

7