ГОСТ Р ИСО/МЭК 12119-2000 Информационная технология (ИТ). Пакеты программ. Требования к качеству и тестирование

    3.2 Документация пользователя

3.2.1 Полнота (completeness)

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

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

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

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

3.2.2 Правильность (correctness)

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

3.2.3 Непротиворечивость (consistency)

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

Примечание - Непротиворечивость программ и данных рассматривается в 3.3.1 d .

3.2.4 Понятность (understandability)

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

3.2.5 Простота обозрения (ease of overview)

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

В каждый документ может быть включено оглавление и предметный указатель.

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