ГОССТАНДАРТ РОССИИ ГОСТ Р ИСО/МЭК 15910-2002 ГОСУДАРСТВЕННЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИ Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА Введение 1 Область применения 2 Соответствие 3 Нормативные ссылки 4 Определения 5 Управление качеством 6 Адаптация 7 Цели 8 Требования 8.1 Процесс документирования 8.1.1 Общие положения 8.1.2 Представление исходных материалов 8.1.3 План документирования 8.1.3.1 Общие положения 8.1.3.2 Определение аудитории пользователей 8.1.3.3 Контроль плана документирования 8.1.4 Проверка (анализ) 8.1.4.1 Общие положения 8.1.4.2 Проверка плана документирования 8.1.4.3 Проверка первой редакции 8.1.4.4 Проверка второго проекта 8.1.4.5 Проверка гранок 8.1.5 Тестирование документации на практичность 8.1.5.1 Общие положения 8.1.5.2 Планирование 8.1.5.3 Программные средства 8.1.5.4 Типовые пользователи 8.1.6 Документация, разработанная другими компаниями по субподрядам 8.1.7 Контроль изменений и сопровождение документации 8.1.7.1 Общие положения 8.1.7.2 Процедуры 8.2 Содержание спецификации стиля 8.2.1 Общие положения 8.2.2 Стиль описания 8.2.2.1 Язык 8.2.2.2 Орфография 8.2.2.3 Грамматика и ее применение 8.2.3 Бумажная документация 8.2.3.1 Компоновка и оригинал-макеты 8.2.3.1.1 Размер (формат) бумаги 8.2.3.1.2 Ориентация (расположение) 8.2.3.1.3 Одно- или двусторонняя печать 8.2.3.1.4 Разрешающая способность типографского или лазерного способа печати 8.2.3.1.5 Ширина внутреннего поля 8.2.3.1.6. Ширина внешних полей 8.2.3.1.7 Цвета красок 8.2.3.1.8 Цвет, масса и качество бумаги 8.2.3.1.9 Разделители 8.2.3.1.10 Метод воспроизведения (тиражирования) и качество 8.2.3.1.11 Переплет 8.2.3.2 Схемы нумерации 8.2.3.2.1 Нумерация страниц 8.2.3.2.2 Нумерация таблиц и рисунков 8.2.4 Электронная документация 8.2.4.1 Типы справочной информации 8.2.4.2 Типы диалоговой (оперативной) документации 8.2.4.3 Оформление 8.2.4.3.1 Общее положение 8.2.4.3.2 Сопутствующие материалы 8.2.4.3.3 Подсветка и использование цвета 8.2.4.3.4 Оформление диалоговой документации и справочного текста 8.2.4.3.5 Заголовки 8.2.4.3.6 Текст основной части 8.2.4.3.7 Навигация 8.2.4.3.8 Использование клавиатуры ПРИЛОЖЕНИЕ А (справочное) Перекрестные ссылки с ГОСТ Р ИСО/МЭК 12207 ПРИЛОЖЕНИЕ В (справочное) Использование настоящего стандарта в договоре B.1 Общие положения B.2 Образец раздела договора В.З Практическое применение настоящего стандарта ПРИЛОЖЕНИЕ С (справочное) Образец плана документирования. Документация пользователя для системы ABC — административного управления магнитными лентами С.1 Введение С.2 Область применения и ограничения С.З Оформление и стиль описания С.4 Аудитория С.5 Проект содержания документации С.6 Номенклатура поставки С.7 Авторские права С.8 Транспортирование С.9 Процесс разработки и контроль С.10 Тиражирование С.11 Проектанты С.12 Ресурсы С.13 Тестирование на практичность С.14 График работ ПРИЛОЖЕНИЕ D (справочное) Отношения между аудиториями, выданными заданиями, бумажной и диалоговой документацией ПРИЛОЖЕНИЕ Е (справочное) Рекомендации по написанию на английском языке документации, подлежащей последующему переводу Е.1 Общие положения Е.2 Терминология Е.3 Стиль перевода Е.3.1 Обозначения Е.3.2 Неоднозначно трактуемые слова Е.3.3 Синтаксис Е.3.4 Пунктуация Е.4 Физические факторы Е.5 Диалоговая информация Е.6 Культурные факторы ПРИЛОЖЕНИЕ F (справочное) Оценка проекта F.1 Общие положения F.2 Поминутный и почасовой методы F.3 Метод нисходящего проектирования F.3.1 Общие положения F.3.2 Пропорции F.3.3 Планирование F.3.4 Первая редакция F.3.5 Вторая редакция F.3.6 Принятая редакция ПРИЛОЖЕНИЕ G (справочное) Оценка плана документирования ПРИЛОЖЕНИЕ Н (справочное) Образец спецификации стиля Н.1 Общие положения Н.2 Элементы стиля Н.3 Спецификация указателя Н.3.1 Общие положения Н.3.2 Качество Н.3.3 Состав (содержание) и организация указателя Н.3.4 Справочные ссылки Н.3.5 Перекрестные ссылки Библиография Тематический указатель
8.1.3.2 Определение аудитории пользователей План документирования должен включать определение аудитории(й) пользователей документации, уровня образования, способностей, подготовки, опыта данных пользователей и других характеристик, связанных с содержанием, структурой и использованием документации.
Обычно имеется ряд различных групп пользователей, преследующих различные цели при использовании конкретной документации. Каждый тип пользователей, включая их характеристики и задачи, решаемые ими при помощи документации, должен быть определен отдельно.
Примечания
1 Данные об определении аудитории пользователей могут быть получены из:
a) результатов изучения аудитории, проведенного заказчиком или документатором;
b) описаний, представляемых заказчиком;
c) определений аудитории, полученных из других источников.
2 По возможности персонал разработчиков документации должен организовать встречи с типовыми пользователями в их рабочей обстановке и обследовать их работу.