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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Примечания

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

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

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

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

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

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

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

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

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

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

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

Примечание — Например, расположение номеров страниц на страницах каждого типа.

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

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

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

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

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

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

Могут быть установлены правила оформления и содержания отчетов.

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

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

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

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

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

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

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

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