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

e) требования к мобильности и рабочей области документации.

8.2.3.1.2 Ориентация (расположение)

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

8.2.3.1.3 Одно- или двусторонняя печать

Следует указать, будет ли документация печататься в одно- или двустороннем формате.

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

8.2.3.1.4 Разрешающая способность типографского или лазерного способа печати

Должна быть определена минимально допустимая разрешающая способность печати (количество точек в 1 дюйме/1 мм).

Примечание — Минимально рекомендуемой является разрешающая способность 300 точек/дюйм.

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 Нумерация страниц

Должна быть определена схема нумерации страниц.

Примечания

1 Каждая страница должна иметь индивидуальный номер. Номера страниц должны быть проставлены в порядке их брошюрования.

2 При брошюровке документа с заменяемыми страницами схема нумерации должна учитывать номер текущей главы (раздела) с номером страницы в данной главе (разделе), например «1–1», «1–2» и т. д. (тем самым обеспечивается вставка страниц в документ без перенумерации всех последующих страниц).

3 В случае брошюровки документа без замены страниц используют порядковую нумерацию, например «1», «2» и т. д. Иногда для нумерации страниц содержания используют другую схему («i», «ii» и т. д.). Следует избегать схожих методов нумерации страниц вспомогательного (указателя и т. д.) и вводного материалов, так как это может привести к неоднозначности в случае изъятия или вставки страниц.

8.2.3.2.2 Нумерация таблиц и рисунков

Должны быть определены схемы нумерации рисунков и таблиц (при необходимости их нумерации).

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

8.2.3.3 Использование сносок или концевых примечаний

Должны быть указаны возможности применения сносок или концевых примечаний.

Примечание — В документации пользователя программного средства данные элементы обычно не используют; в спецификации стиля следует запретить их применение.

8.2.3.4 Правила пагинации и плотности документа

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

8.2.3.5 Вводные и вспомогательные материалы

Должны быть определены виды вводных и вспомогательных материалов, включая (при необходимости) требования к содержанию и оформлению:

a) титульного листа;

b) информации о гарантиях, авторских правах, компенсациях и торговой марке;

c) содержания;

d) списка рисунков и таблиц;

e) приложений;

f) словаря (глоссария);

g) перечней обозначений и сокращений;

п) указателя.

Должен быть определен порядок расположения данных элементов в документе.

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

8.2.3.6 Текст основной части документа

8.2.3.6.1 Гарнитуры и кегли шрифтов

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

8.2.3.6.2 Число колонок

Должно быть указано число колонок, используемых при оформлении страниц документа.

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

8.2.3.6.3 Отступы по горизонтали и пробелы по вертикали

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

Примечания

1 Для языков романской группы в тексте основной части документа следует избегать строк длиной более 65 и менее 30 символов.

2 Для подсчета соответствующей длины строки изначально выбирают строку длиной 5 см и считают количество символов (включая пробелы), содержащихся в десяти строках обычного текста (без разбивки на абзацы) данной длины. Полученное число делят на 50 для определения среднего числа символов на 1 см. Затем принимают решение о необходимом количестве символов в строке (которое должно быть между 30 и 65) и делят его на ранее определенное среднее число символов на 1 см для получения необходимой длины строки в сантиметрах.

8.2.3.6.4 Выравнивание

Должны быть определены параметры выравнивания текста основной части на выбранном языке (например, левостороннее или по ширине).

8.2.3.7 Заголовки

8.2.3.7.1 Количество уровней и наименования заголовков

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

Примечание — Следует избегать использования более трех уровней заголовков. Трех уровней обычно достаточно.

8.2.3.7.2 Стиль текста заголовков

Должен быть определен стиль текста заголовков для используемых в документации языков (например, «Стиль основных предложений», «Все буквы заглавные»).

8.2.3.7.3 Гарнитуры, кегли шрифтов и отступы для заголовков каждого уровня

Должны быть определены гарнитуры и кегли шрифтов, отступы по горизонтали и интервалы по вертикали для каждого уровня заголовков.

8.2.3.7.4 Графические элементы, используемые в заголовках

Должны быть определены графические элементы (например, подчеркивание, раскраска, пиктограммы), применяемые на каждом уровне заголовков.

8.2.3.8 Верхние и нижние колонтитулы