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

документатором.

8.2 Содержание спецификации стиля

8.2.1 Общие положения

В данном подразделе определено содержание спецификации стиля документации.

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

8.2.2 Стиль описания

8.2.2.1 Язык

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

8.2.2.2 Орфография

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

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

8.2.2.3 Грамматика и ее применение

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

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

8.2.3 Бумажная документация

8.2.3.1 Компоновка и оригинал-макеты

8.2.3.1.1 Размер (формат) бумаги

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

Примечание — При выборе размера бумаги должно быть учтено следующее:

a) форматы А4, А5 и В5 указаны в настоящем стандарте (см. 4.1 и 4.5);

b) как будут храниться данные документы (в некоторых архивах возникают проблемы с хранением документов в конкретных форматах);

c) используются ли распечатки экранов (распечатки целых экранов в формате А5 недостаточно разборчивы);

d) используемый национальный стандартный формат бумаги, если документация представляется в виде фотокопий;

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

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

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

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

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

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

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

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

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