ГОССТАНДАРТ РОССИИ - Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА

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

4.19 нижний колонтитул (footer): Справочная(ые) строка(и) под текстом страницы, указывающая(ие) на ее содержание (например, номер страницы).

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

4.21 вводный материал (front matter): Начальная часть или глава издания, например, титульный лист и содержание.

4.22 верхний колонтитул (header): Справочная(ые) строка(и) над текстом страницы.

4.23 заголовок (heading): Название внутреннего подраздела издания, определяющее тему, раскрываемую в последующем тексте.

4.24 справочная система (help system): См. 4.32.

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

4.26 элемент документации (item of documentation): Целевая информация, предназначенная для конкретной аудитории, размещенная на конкретном носителе (например, в книге, на диске, в краткой справочной карте) в заданном формате.

4.27справочная ссылка (location reference): Метка, выделяющая заголовок или подзаголовок в тематическом (предметном) указателе, показывающая, к какой части документа они относятся.

4.28 измененный документ (изменение документа) (mark-up): Документ, содержащий заполненные листы изменений, а также процесс создания такого документа.

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

4.30 навигация (navigation): Способ перехода пользователя от одной части прикладных программных средств к другой.

4.31 диалоговая документация (on-line documentation): Информация, доступная пользователю при эксплуатации программного средства, которая не обязательно привязана к конкретному контексту (см. также 4.25).

4.32система диалоговой документации или справочная система (on-line documentation system or help system): Часть программы (иногда отдельная программа), запрашиваемая пользователем и позволяющая ему просматривать части диалоговой документации или справочного текста (см. также 4.25 и 4.31).

4.33 концевая висячая строка (orphan): Строка части текста (главы, раздела и т. д.) единственная на странице (полосе).

4.34 бумажный документ (orphan): Часть документации, представляемая в печатном виде.

4.35 элиз (доп. пиксель) (pixel): Наименьший элемент изображения на экране дисплея; сокращение от «элемент изображения» («picture element»).

4.36 точка (point): Единица типометрической типографской системы, выражаемая расстоянием по вертикали и содержащая в 1 мм приблизительно 2,8 точек (в одном дюйме приблизительно 72 точки).

4.37 процесс (process): Набор преобразующий исходные данные в выходные результаты (3.17 ГОСТ Р ИСО/МЭК 12207).

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

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

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

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

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

4.41 прототип (prototype): Модель или предварительная реализация части программного средства, пригодная для оценки проекта системы, ее потенциальных рабочих характеристик, производства или лучшего понимания требований к программному средству.

4.42 оборот (листа) (recto): Страница нижняя по отношению к левой или правой верхней стороне крышки переплета.

4.43 распечатка экрана (screen dump): Предполагаемое изображение, которое пользователь должен видеть на экране при эксплуатации программного средства.

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

4.45 содержание (table of contents): Указатель заголовков издания с указанием номеров страниц в порядке их возрастания.

4.46 таблица действующих страниц (лист изменений) (table of effective pages): Перечень последних версий номеров каждой замененной страницы бумажного документа. При замене отдельных страниц в перечне указывают старые и новые номера страниц.

4.47 план выбора группы проектантов (team selection plan): Документ, устанавливающий требования к квалификации и опыту персонала, разрабатывающего документацию.

4.48 страница-развертка (throwclear): Страница-раскладка, выполненная таким образом, что в развернутом виде и закрытом издании (книге, руководстве) доступна для обозрения (чтения) совместно с предыдущими страницами.

4.49 практическая лаборатория (usability laboratory): Комплекс аналитических и исследовательских помещений, оснащенных видео- и аудиооборудованием для регистрации ответов на запросы пользователей.

4.50 тестирование на практичность (usability testing): Формальный процесс оценки соответствия документации установленным требованиям.

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

4.52 пользователь (user): Лицо или организация, которые используют действующую систему для выполнения конкретной функции (3.34 ГОСТ Р ИСО/МЭК 12207).

Примечание — см. также 4.3.

4.53 разворот (листа) (verso): Две смежные страницы раскрытого издания, левая и правая.

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

4.55 разделитель пассивный (white space, passive): Верхнее, нижнее, левое и правое поля, окружающие текст.

4.56 начальная висячая строка (widow): Первая строка части текста (главы, раздела и т. д.), завершающая последнюю строку на странице (полосе).

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

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

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

Настоящий стандарт по существу является стандартом на процесс. Стандарт не определяет компоновку конкретного документа, его содержание и другие аспекты комплектности документации, однако он устанавливает метод планирования и проведения процесса документирования.

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

Когда минимальный состав документации определяется заказчиком (например, с использованием ГОСТ Р ИСО 9127 или ИСО/МЭК 6592 [1]), это должно быть учтено документатором при разработке плана документирования.