Информационная технология. Процесс создания документации пользователя программного средства - [2]

Примечание — Одна и та же программная документация может использоваться различными аудиториями (например, руководством, операторами по вводу исходных данных или сопроводителями).

4.4 изучение аудитории (audience research): Планируемый процесс опроса потенциальных пользователей и анализа его индивидуальных и интегральных результатов.

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

4.5 В5: Размеры сторон листа 176×250 мм (см. ИСО 216).

4.6 вспомогательный материал (back matter): Материал, содержащийся в конце книги или руководства, например, тематический указатель.

4.7 фотошаблоны (camera-ready originals):Набор изображений на бумаге, фотопленке или другом носителе, с которого может быть сделана фотокопия, где каждое изображение содержит все необходимые текстовые и графические элементы одной страницы печатного документа, скомпонованные должным образом.

4.8 дата пересмотра (cut-off date): Дата, по истечении которой все изменения, внесенные впрограммные средства, описываются в новой редакции документации, более верной по сравнению с действующей.

4.9 номенклатура поставки (deliverables): Объекты (элементы, изделия и т. д.), поставляемые заказчику по условиям договора.

4.10 документ (document): См. элемент документации (4.26).

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

4.12 персонал разработчиков документации (documentation development staff): Весь персонал, привлекаемый на любом этапе планирования, написания, редактирования и выпуска документации.

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

4.13 план документирования (documentation plan): Документ, в котором излагаются необходимые элементы проекта документирования.

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

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

4.15 электронная копия (electronic copy): Компьютерный диск или другой машиночитаемый носитель информации, содержащий файл или файлы, с которого(ых) может быть распечатан документ.

4.16 n-штрих (en dash): Штрих, имеющий такую же ширину, как и строчная буква «n».

4.17 концевые примечания (endnotes): Примечания, собранные в конце главы или документа.

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).