ГОССТАНДАРТ РОССИИ - Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА
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».
Таблица 1 — Угол обзора и число точек
Угол обзора, угловые минуты Высота, мм Приблизительное число точек 10 2,9 12 15 4,4 18 20 5,8 24 25 7,3 30 30 8,8 36 35 10,2 42 40 11,6 48 45 13,1 54 50 14,6 60 178.2.4.3.7 Навигация
Должны быть установлены правила навигации по электронной документации.
Примечания
1 Уровни связей информации в документации должны контролироваться, обеспечивая пользователю возможности возврата в исходный пункт, содержание или указатель без блуждания в документе.
2 Должны быть выработаны и применены правила структурирования документа. Например, количество связей в каждой информационной цепочке должно быть ограничено числом X. Значение X должно быть таким, чтобы пользователи имели соответствующие возможности для возврата к содержанию или перехода к другим структурным элементам документа. Уровни заголовков также могут быть взаимоувязаны с уровнями сложности документа (например, «В заголовках первого уровня представляется только общая информация»).
3 Проблемно ориентированная и общая информация должны быть выделены в отдельные разделы с входящими связями между ними, тем самым позволяя пользователю изучить конкретную задачу без непреднамеренного поиска в общих материалах, что может дезориентировать и отвлекать его.
4 Следует использовать графические материалы. Общая схема, отражающая основные разделы документа с гипертекстовыми связями между ними, дает пользователю ясное визуальное представление о структуре документа.
5 В начале документа должен быть раздел с рекомендациями пользователю, содержащий информацию по применению диалоговой документации. Данный раздел следует использовать для пояснения структуры документа и правил по его применению.
8.2.4.3.8 Использование клавиатуры
Должны быть определены правила использования специальных клавиш в диалоговой документации.
Примечания
1 Пользователь должен иметь возможность вызова справки, используя конкретную клавишу или комбинацию клавиш, в любой точке программы. Пользователь также должен иметь возможность вызова диалоговой документации с использованием единственной клавиши или комбинации клавиш.
2 В плане документирования должны быть определены условные наименования и функции всех специальных функциональных клавиш, используемых в системе диалоговой или справочной документации.
3 Применение специальной функциональной клавиши в документации должно быть соотнесено с использованием функциональных клавиш в самом программном приложении.
ПРИЛОЖЕНИЕ А (справочное)
Перекрестные ссылки с ГОСТ Р ИСО/МЭК 12207
Настоящий стандарт соответствует ГОСТ Р ИСО/МЭК 12207 в части реализации его подраздела 6.1 по отношению к документации пользователя (см. таблицу А.1).
Таблица А.1 — Перекрестные ссылки с ГОСТ Р ИСО/МЭК 12207
Пункты ГОСТ Р ИСО/МЭК 12207 Пункты настоящего стандарта 6.1.1.1 8.1.3 План документирования 6.1.2.1 8.2 Содержание спецификации стиля 6.1.2.2 8.1.2 Представление исходных материалов 6.1.2.3 8.1.4 Проверка (анализ) 6.1.3.1 8.2 Содержание спецификации стиля. 8.1.3 План документирования 6.1.3.2 8.1.3.3 Проверка плана документирования 6.1.4.1 8.1.7 Контроль изменений и сопровождение документацииПРИЛОЖЕНИЕ В (справочное)
Использование настоящего стандарта в договоре
B.1 Общие положения
В настоящем стандарте имеются разделы, требования которых необходимо пояснить применительно к конкретному договору или другим ссылочным документам (например, международным). В свою очередь, план документирования также нуждается в пояснении. В договоре должны быть даны ответы на следующие вопросы:
a) откуда поступает информация о изучении аудитории? (Ответ рекомендуемый);
b) необходимо ли готовить более двух проектов комплекта документации и одного комплекта гранок?
(При необходимости, в настоящем стандарте по умолчанию предусмотрены два проекта комплектов документации и один комплект гранок);
c) кто представляет исходные материалы? (Обычно это очевидно, но для проектов со сложными взаимосвязями между вовлеченными сторонами нуждается в уточнении);
d) какие уровни конфиденциальности или секретности необходимо использовать для материалов, предоставляемых заказчиком документатору?
e) имеется ли стандарт на оформление бумажной документации? (Это не обязательно; по умолчанию может быть использована спецификация стиля документации, установленная в настоящем стандарте; затем в плане документирования может быть оговорено количество проектов документации и т. д.).
B.2 Образец раздела договора
В соответствии с настоящим стандартом образец раздела договора может быть представлен в следующем виде.
Пример
Раздел 123 Документация
Вся документация пользователя должна соответствовать ГОСТ Р ИСО/МЭК 15910.
В комплект документации не следует включать диалоговую документацию и справочные тексты. Вся информация об изучении аудитории и другие исходные материалы должны представляться заказчиком.
Должно быть проведено одно тестирование на практичность при поставке первого модуля программного средства, которое должно предусматривать проверки всех функциональных возможностей данного модуля в интересах пяти различных типовых пользователей.
В.З Практическое применение настоящего стандарта
