Чтение онлайн

–  продукта;

–  расширения продукта, полностью описанного в описании продукта;

–  расширения продукта, на которое дана ссылка в описании продукта;

–  не гарантируемого (не обязательного) приложения.

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

b) Граничные значения

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

–  минимальные или максимальные значения;

–  длины ключей;

–  максимальное число записей в файле;

–  максимальное число критериев поиска;

–  минимальный объем выборки.

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

с) Защита

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

3.1.4 Формулировки надежности

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

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

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

–  проверки достоверности исходных данных;

–  защита против серьезных последствий ошибки пользователя;

–  восстановление при ошибках.

3.1.5 Формулировки практичности

a) Интерфейс пользователя

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

b) Требуемые знания

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

–  знание соответствующей технической области;

–  знание операционной системы;

–  знания, получаемые в результате специального обучения;

–  знание языков, отличных от языка, на котором написано описание продукта.

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

Примечание - Данное требование строже, чем аналогичное требование 6.1.7 ГОСТ Р ИСО 9127 [13], согласно которому указание языка является необязательным.

c) Адаптация к потребностям пользователя

Если продукт может настраиваться (адаптироваться) пользователем, то должны быть указаны инструментальные средства для проведения такой настройки и условия их применения. Например:

–  изменение параметров;

–  изменение алгоритмов вычислений;

–  назначение функциональных клавиш.

d) Защита от нарушения авторских прав

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

–  техническая защита от копирования;

–  запрограммированные даты окончания использования продукта;

–  интерактивные напоминания об оплате за копии.

e) Эффективность применения и удовлетворение потребностей пользователя

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

Примечание - Такая информация может быть описана в соответствии с рекомендациями, приведенными в ИСО 9241-11 [16].

3.1.6 Формулировки эффективности

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

3.1.7 Формулировки сопровождаемости

В описание продукта могут быть внесены формулировки требований (правил) по сопровождению продукта.

3.1.8 Формулировки мобильности (переносимости)

В описание продукта могут быть внесены формулировки требований (правил) по мобильности продукта.

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

3.2.1 Полнота (completeness)

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

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

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

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

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

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

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

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

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