ГОСТ Р ИСО/МЭК 15910–2002 Информационная технология. Процесс создания документации пользователя программного средства. Information technology. Software user documentation process. УДК 681.3.06:006.354 ОКС 35.08 П85 ОКСТУ 5001. Редакция от 17.12.2023.
A4, A5 по ГОСТ Р ИСО/МЭК 15910-2002
Размеры сторон листа 210 х 297 мм и 148 х 210 мм соответственно (см. ИСО 216, ГОСТ 2.301) [из 4.1 ГОСТ Р ИСО/МЭК 15910–2002]
Заказчик (Acquirer) по ГОСТ Р ИСО/МЭК 15910-2002
Организация, которая приобретает или получает систему, программный продукт или программную услугу от поставщика (3.1 ГОСТ Р ИСО/МЭК 12207).
Примечание — Заказчиком может быть: оптовый или розничный покупатель, клиент, собственник или пользователь. В контексте настоящего стандарта заказчиком является сторона, запрашивающая документацию. Отметим, что наличие у заказчика документации не является обязательным. Заказчик и разработчик документации могут быть представителями одной организации, или заказчиком может быть разработчик данного программного средства.
[из 4.2 ГОСТ Р ИСО/МЭК 15910–2002]
Аудитория (Audience) по ГОСТ Р ИСО/МЭК 15910-2002
Категория пользователей, предъявляющих к документации одинаковые или аналогичные требования и характеристики (например, в части использования документации, ее назначения, уровня обучения, возможностей и опыта персонала), определяющие содержание, структуру и назначение данной документации.
Примечание — Одна и та же программная документация может использоваться различными аудиториями (например, руководством, операторами по вводу исходных данных или сопроводителями).
[из 4.3 ГОСТ Р ИСО/МЭК 15910–2002]
Изучение аудитории (Audience research) по ГОСТ Р ИСО/МЭК 15910-2002
Планируемый процесс опроса потенциальных пользователей и анализа его индивидуальных и интегральных результатов.
Примечание — Целью данного процесса является определение возможностей, квалификации, опыта, предубежденности и преимуществ потенциальных читателей документа.
[из 4.4 ГОСТ Р ИСО/МЭК 15910–2002]
B5 по ГОСТ Р ИСО/МЭК 15910-2002
Размеры сторон листа 176 х 250 мм (см. ИСО 216) [из 4.5 ГОСТ Р ИСО/МЭК 15910–2002]
Вспомогательный материал (Back matter) по ГОСТ Р ИСО/МЭК 15910-2002
Материал, содержащийся в конце книги или руководства, например, тематический указатель [из 4.6 ГОСТ Р ИСО/МЭК 15910–2002]
Дата пересмотра (Cut-off date) по ГОСТ Р ИСО/МЭК 15910-2002
Дата, по истечении которой все изменения, внесенные в программные средства, описываются в новой редакции документации, более верной по сравнению с действующей [из 4.8 ГОСТ Р ИСО/МЭК 15910–2002]
Документ (Document) по ГОСТ Р ИСО/МЭК 15910-2002
См. элемент документации (4.26) [из 4.10 ГОСТ Р ИСО/МЭК 15910–2002]
Документация (Documentation) по ГОСТ Р ИСО/МЭК 15910-2002
Печатные руководства пользователя, диалоговая (оперативная) документация и справочный текст («хелпы»), описывающие, как пользоваться программным продуктом [из 4.11 ГОСТ Р ИСО/МЭК 15910–2002]
Персонал разработчиков документации (Documentation development staff) по ГОСТ Р ИСО/МЭК 15910-2002
Весь персонал, привлекаемый на любом этапе планирования, написания, редактирования и выпуска документации.
Примечание — Данный термин охватывает коллектив авторов, оформителей, иллюстраторов и администрации проекта.
[из 4.12 ГОСТ Р ИСО/МЭК 15910–2002]
План документирования (Documentation plan) по ГОСТ Р ИСО/МЭК 15910-2002
Документ, в котором излагаются необходимые элементы проекта документирования [из 4.13 ГОСТ Р ИСО/МЭК 15910–2002]
Документатор (Documenter) по ГОСТ Р ИСО/МЭК 15910-2002*
Сторона, создающая документацию.
Примечание — В настоящем стандарте не используют термин разработчик (developer) (в смысле 3.8 по ГОСТ Р ИСО/МЭК 12207), так как в случае документирования разработчик программного средства часто является заказчиком документации и использование термина разработчик может привести к разночтению. Поэтому используют термин документатор.
[из 4.14 ГОСТ Р ИСО/МЭК 15910–2002]
Электронная копия (Electronic copy) по ГОСТ Р ИСО/МЭК 15910-2002
Компьютерный диск или другой машиночитаемый носитель информации, содержащий файл или файлы, с которого (ых) может быть распечатан документ [из 4.15 ГОСТ Р ИСО/МЭК 15910–2002]
N-штрих (en dash) по ГОСТ Р ИСО/МЭК 15910-2002
Штрих, имеющий такую же ширину, как и строчная буква «n» [из 4.16 ГОСТ Р ИСО/МЭК 15910–2002]
Концевые примечания (Endnotes) по ГОСТ Р ИСО/МЭК 15910-2002
Примечания, собранные в конце главы или документа [из 4.17 ГОСТ Р ИСО/МЭК 15910–2002]
Страница-раскладка (Foldout) по ГОСТ Р ИСО/МЭК 15910-2002
Страница, сложенная так, что ее задняя часть шире передней (немного превышает основной формат), которую можно развернуть [из 4.18 ГОСТ Р ИСО/МЭК 15910–2002]
Нижний колонтитул (Footer) по ГОСТ Р ИСО/МЭК 15910-2002
Справочная (ые) строка (и) под текстом страницы, указывающая (ие) на ее содержание (например, номер страницы) [из 4.19 ГОСТ Р ИСО/МЭК 15910–2002]
Сноска (Footnote) по ГОСТ Р ИСО/МЭК 15910-2002
Помещаемый внизу страницы (колонки) текст (примечание, библиографическая ссылка и т.д.), связанный с основным текстом знаком сноски (цифровым номером, звездочкой), закрываемым круглой скобкой, набираемый обычно шрифтом пониженного кегля по сравнению со шрифтом основного текста и отделяемый от него пробелом или пробелом с тонкой короткой линейкой [из 4.20 ГОСТ Р ИСО/МЭК 15910–2002]
Вводный материал (Front matter) по ГОСТ Р ИСО/МЭК 15910-2002
Начальная часть или глава издания, например, титульный лист и содержание [из 4.21 ГОСТ Р ИСО/МЭК 15910–2002]
Справочная система (Help system) по ГОСТ Р ИСО/МЭК 15910-2002
См. 4.32 [из 4.24 ГОСТ Р ИСО/МЭК 15910–2002]
Справочный текст (Help text) по ГОСТ Р ИСО/МЭК 15910-2002
Текст, облегчающий и убыстряющий пользователю при эксплуатации программного средства поиск содержащихся в издании объектов, автоматически выбираемый в зависимости от контекста, в котором он вызывается, т.е. справочный текст контекстно зависим [из 4.25 ГОСТ Р ИСО/МЭК 15910–2002]
Элемент документации (Item of documentation) по ГОСТ Р ИСО/МЭК 15910-2002
Целевая информация, предназначенная для конкретной аудитории, размещенная на конкретном носителе (например, в книге, на диске, в краткой справочной карте) в заданном формате [из 4.26 ГОСТ Р ИСО/МЭК 15910–2002]
Справочная ссылка (Location reference) по ГОСТ Р ИСО/МЭК 15910-2002
Метка, выделяющая заголовок или подзаголовок в тематическом (предметном) указателе, показывающая, к какой части документа они относятся [из 4.27 ГОСТ Р ИСО/МЭК 15910–2002]
Измененный документ (изменение документа) (Mark-up) по ГОСТ Р ИСО/МЭК 15910-2002
Документ, содержащий заполненные листы изменений, а также процесс создания такого документа [из 4.28 ГОСТ Р ИСО/МЭК 15910–2002]
Оригинал-макет (Mechanicals) по ГОСТ Р ИСО/МЭК 15910-2002
Оригинал, напечатанный как образец для набора, содержащий подробные текстовые, переплетные, издательские и компоновочные характеристики печатной продукции (издания) [из 4.29 ГОСТ Р ИСО/МЭК 15910–2002]
Навигация (Navigation) по ГОСТ Р ИСО/МЭК 15910-2002
Способ перехода пользователя от одной части прикладных программных средств к другой [из 4.30 ГОСТ Р ИСО/МЭК 15910–2002]
Диалоговая документация (On-line documentation) по ГОСТ Р ИСО/МЭК 15910-2002
Информация, доступная пользователю при эксплуатации программного средства, которая не обязательно привязана к конкретному контексту (см. также 4.25) [из 4.31 ГОСТ Р ИСО/МЭК 15910–2002]
Система диалоговой документации или справочная система (On-line documentation system or help system) по ГОСТ Р ИСО/МЭК 15910-2002
Часть программы (иногда отдельная программа), запрашиваемая пользователем и позволяющая ему просматривать части диалоговой документации или справочного текста (см. также 4.25 и 4.31) [из 4.32 ГОСТ Р ИСО/МЭК 15910–2002]
Концевая висячая строка (Orphan) по ГОСТ Р ИСО/МЭК 15910-2002
Строка части текста (главы, раздела и т.д.) единственная на странице (полосе) [из 4.33 ГОСТ Р ИСО/МЭК 15910–2002]
Бумажный документ (Orphan) по ГОСТ Р ИСО/МЭК 15910-2002
Часть документации, представляемая в печатном виде [из 4.34 ГОСТ Р ИСО/МЭК 15910–2002]
Точка (Point) по ГОСТ Р ИСО/МЭК 15910-2002
Единица типометрической типографской системы, выражаемая расстоянием по вертикали и содержащая в 1 мм приблизительно 2,8 точек (в одном дюйме приблизительно 72 точки) [из 4.36 ГОСТ Р ИСО/МЭК 15910–2002]
Процесс (Process) по ГОСТ Р ИСО/МЭК 15910-2002
Набор, преобразующий исходные данные в выходные результаты (3.17 ГОСТ Р ИСО/МЭК 12207) [из 4.37 ГОСТ Р ИСО/МЭК 15910–2002]
Продукция (Product) по ГОСТ Р ИСО/МЭК 15910-2002
Полный набор компьютерных программ, процедур и соответствующих им документации и данных, предназначенный для поставки.
Примечание — Используют также термин «программный продукт».
[из 4.38 ГОСТ Р ИСО/МЭК 15910–2002]
Производство (Production) по ГОСТ Р ИСО/МЭК 15910-2002
Предварительная подготовка текста к переводу его в фотошаблоны, законченные справочные тексты или диалоговую документацию [из 4.39 ГОСТ Р ИСО/МЭК 15910–2002]
Гранки (Proof) по ГОСТ Р ИСО/МЭК 15910-2002
Окончательная редакция бумажного документа, представленная перед печатью заказчику для рассмотрения и утверждения.
Примечание — При отсутствии замечаний окончательный документ должен быть во всех отношениях идентичен гранкам, за исключением вида бумаги, переплета и цветового оформления. Гранки обычно являются фотокопией фотошаблонов.
[из 4.40 ГОСТ Р ИСО/МЭК 15910–2002]
Прототип (Prototype) по ГОСТ Р ИСО/МЭК 15910-2002
Модель или предварительная реализация части программного средства, пригодная для оценки проекта системы, ее потенциальных рабочих характеристик, производства или лучшего понимания требований к программному средству [из 4.41 ГОСТ Р ИСО/МЭК 15910–2002]
Оборот (листа) (Recto) по ГОСТ Р ИСО/МЭК 15910-2002
Страница, нижняя по отношению к левой или правой верхней стороне крышки переплета [из 4.42 ГОСТ Р ИСО/МЭК 15910–2002]
Распечатка экрана (Screen dump) по ГОСТ Р ИСО/МЭК 15910-2002
Предполагаемое изображение, которое пользователь должен видеть на экране при эксплуатации программного средства [из 4.43 ГОСТ Р ИСО/МЭК 15910–2002]
Система (System) по ГОСТ Р ИСО/МЭК 15910-2002
Комплекс процессов, технических и программных средств, устройств, обслуживаемый персоналом и обладающий возможностью удовлетворять установленным потребностям и целям (3.31 ГОСТ Р ИСО/МЭК 12207) [из 4.44 ГОСТ Р ИСО/МЭК 15910–2002]
Содержание (Table of contents) по ГОСТ Р ИСО/МЭК 15910-2002
Указатель заголовков издания с указанием номеров страниц в порядке их возрастания [из 4.45 ГОСТ Р ИСО/МЭК 15910–2002]
Таблица действующих страниц (лист изменений) (Table of effective pages) по ГОСТ Р ИСО/МЭК 15910-2002
Перечень последних версий номеров каждой замененной страницы бумажного документа. При замене отдельных страниц в перечне указывают старые и новые номера страниц [из 4.46 ГОСТ Р ИСО/МЭК 15910–2002]
План выбора группы проектантов (Team selection plan) по ГОСТ Р ИСО/МЭК 15910-2002
Документ, устанавливающий требования к квалификации и опыту персонала, разрабатывающего документацию [из 4.47 ГОСТ Р ИСО/МЭК 15910–2002]
Страница-развертка (Throwclear) по ГОСТ Р ИСО/МЭК 15910-2002
Страница–раскладка, выполненная таким образом, что в развернутом виде и закрытом издании (книге, руководстве) доступна для обозрения (чтения) совместно с предыдущими страницами [из 4.48 ГОСТ Р ИСО/МЭК 15910–2002]
Практическая лаборатория (Usability laboratory) по ГОСТ Р ИСО/МЭК 15910-2002
Комплекс аналитических и исследовательских помещений, оснащенных видео– и аудиооборудованием для регистрации ответов на запросы пользователей [из 4.49 ГОСТ Р ИСО/МЭК 15910–2002]
Тестирование на практичность (Usability testing) по ГОСТ Р ИСО/МЭК 15910-2002
Формальный процесс оценки соответствия документации установленным требованиям [из 4.50 ГОСТ Р ИСО/МЭК 15910–2002]
Пользователь (User) по ГОСТ Р ИСО/МЭК 15910-2002
Лицо или организация, которые используют действующую систему для выполнения конкретной функции (3.34 ГОСТ Р ИСО/МЭК 12207).
Примечание — см. также 4.3.
[из 4.52 ГОСТ Р ИСО/МЭК 15910–2002]
Разворот (листа) (Verso) по ГОСТ Р ИСО/МЭК 15910-2002
Две смежные страницы раскрытого издания, левая и правая [из 4.53 ГОСТ Р ИСО/МЭК 15910–2002]
Разделитель активный (White space, active) по ГОСТ Р ИСО/МЭК 15910-2002
Пространство (за исключением полей), охватывающее текстовые и графические элементы, разделяющее текст, отделяющее тематические и подтематические составляющие текста, указывающее в тексте тематические и иерархические отношения, выделяющее соответствующую информацию и облегчающее чтение текста [из 4.54 ГОСТ Р ИСО/МЭК 15910–2002]
Разделитель пассивный (White space, passive) по ГОСТ Р ИСО/МЭК 15910-2002
Верхнее, нижнее, левое и правое поля, окружающие текст [из 4.55 ГОСТ Р ИСО/МЭК 15910–2002]
Начальная висячая строка (Widow) по ГОСТ Р ИСО/МЭК 15910-2002
Первая строка части текста (главы, раздела и т.д.), завершающая последнюю строку на странице (полосе) [из 4.56 ГОСТ Р ИСО/МЭК 15910–2002]