Из ГОСТ Р ИСО/МЭК 15910-2002 Информационная технология. Процесс создания документации пользователя программного средства

ГОСТ Р ИСО/МЭК 15910–2002 Информационная технология. Процесс создания документации пользователя программного средства. Information technology. Software user documentation process. УДК 681.3.06:006.354 ОКС 35.08 П85 ОКСТУ 5001. Редакция от 17.12.2023.

Заказчик (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]

Фотошаблоны (Camera-ready originals) по ГОСТ Р ИСО/МЭК 15910-2002

Набор изображений на бумаге, фотопленке или другом носителе, с которого может быть сделана фотокопия, где каждое изображение содержит все необходимые текстовые и графические элементы одной страницы печатного документа, скомпонованные должным образом [из 4.7 ГОСТ Р ИСО/МЭК 15910–2002]

Персонал разработчиков документации (Documentation development staff) по ГОСТ Р ИСО/МЭК 15910-2002

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

Примечание — Данный термин охватывает коллектив авторов, оформителей, иллюстраторов и администрации проекта.

[из 4.12 ГОСТ Р ИСО/МЭК 15910–2002]

Документатор (Documenter) по ГОСТ Р ИСО/МЭК 15910-2002*

Сторона, создающая документацию.

Примечание — В настоящем стандарте не используют термин разработчик (developer) (в смысле 3.8 по ГОСТ Р ИСО/МЭК 12207), так как в случае документирования разработчик программного средства часто является заказчиком документации и использование термина разработчик может привести к разночтению. Поэтому используют термин документатор.

[из 4.14 ГОСТ Р ИСО/МЭК 15910–2002]

Сноска (Footnote) по ГОСТ Р ИСО/МЭК 15910-2002

Помещаемый внизу страницы (колонки) текст (примечание, библиографическая ссылка и т.д.), связанный с основным текстом знаком сноски (цифровым номером, звездочкой), закрываемым круглой скобкой, набираемый обычно шрифтом пониженного кегля по сравнению со шрифтом основного текста и отделяемый от него пробелом или пробелом с тонкой короткой линейкой [из 4.20 ГОСТ Р ИСО/МЭК 15910–2002]

Справочный текст (Help text) по ГОСТ Р ИСО/МЭК 15910-2002

Текст, облегчающий и убыстряющий пользователю при эксплуатации программного средства поиск содержащихся в издании объектов, автоматически выбираемый в зависимости от контекста, в котором он вызывается, т.е. справочный текст контекстно зависим [из 4.25 ГОСТ Р ИСО/МЭК 15910–2002]

Элемент документации (Item of documentation) по ГОСТ Р ИСО/МЭК 15910-2002

Целевая информация, предназначенная для конкретной аудитории, размещенная на конкретном носителе (например, в книге, на диске, в краткой справочной карте) в заданном формате [из 4.26 ГОСТ Р ИСО/МЭК 15910–2002]

Оригинал-макет (Mechanicals) по ГОСТ Р ИСО/МЭК 15910-2002

Оригинал, напечатанный как образец для набора, содержащий подробные текстовые, переплетные, издательские и компоновочные характеристики печатной продукции (издания) [из 4.29 ГОСТ Р ИСО/МЭК 15910–2002]

Система диалоговой документации или справочная система (On-line documentation system or help system) по ГОСТ Р ИСО/МЭК 15910-2002

Часть программы (иногда отдельная программа), запрашиваемая пользователем и позволяющая ему просматривать части диалоговой документации или справочного текста (см. также 4.25 и 4.31) [из 4.32 ГОСТ Р ИСО/МЭК 15910–2002]

Продукция (Product) по ГОСТ Р ИСО/МЭК 15910-2002

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

Примечание — Используют также термин «программный продукт».

[из 4.38 ГОСТ Р ИСО/МЭК 15910–2002]

Гранки (Proof) по ГОСТ Р ИСО/МЭК 15910-2002

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

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

[из 4.40 ГОСТ Р ИСО/МЭК 15910–2002]

Прототип (Prototype) по ГОСТ Р ИСО/МЭК 15910-2002

Модель или предварительная реализация части программного средства, пригодная для оценки проекта системы, ее потенциальных рабочих характеристик, производства или лучшего понимания требований к программному средству [из 4.41 ГОСТ Р ИСО/МЭК 15910–2002]

Система (System) по ГОСТ Р ИСО/МЭК 15910-2002

Комплекс процессов, технических и программных средств, устройств, обслуживаемый персоналом и обладающий возможностью удовлетворять установленным потребностям и целям (3.31 ГОСТ Р ИСО/МЭК 12207) [из 4.44 ГОСТ Р ИСО/МЭК 15910–2002]

Таблица действующих страниц (лист изменений) (Table of effective pages) по ГОСТ Р ИСО/МЭК 15910-2002

Перечень последних версий номеров каждой замененной страницы бумажного документа. При замене отдельных страниц в перечне указывают старые и новые номера страниц [из 4.46 ГОСТ Р ИСО/МЭК 15910–2002]

Страница-развертка (Throwclear) по ГОСТ Р ИСО/МЭК 15910-2002

Страница–раскладка, выполненная таким образом, что в развернутом виде и закрытом издании (книге, руководстве) доступна для обозрения (чтения) совместно с предыдущими страницами [из 4.48 ГОСТ Р ИСО/МЭК 15910–2002]

Разделитель активный (White space, active) по ГОСТ Р ИСО/МЭК 15910-2002

Пространство (за исключением полей), охватывающее текстовые и графические элементы, разделяющее текст, отделяющее тематические и подтематические составляющие текста, указывающее в тексте тематические и иерархические отношения, выделяющее соответствующую информацию и облегчающее чтение текста [из 4.54 ГОСТ Р ИСО/МЭК 15910–2002]