ГОСТ Р ИСО 9127-94 Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов

     6.5 Использование программного средства (ОБ)

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

a) подготовку к использованию;

b) входные команды и данные;

c) функции программного средства;

d) вывод результатов;

е) сообщения об ошибках и отказах, корректирующие и восстанавливающие действия.

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

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

6.5.1 Загрузка программного средства (ОБ)

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

6.5.2 Управляющие инструкции, команды или языковые правила (ОБ)

а) Управляющие инструкции и команды (ОБ)

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

b) Выходные сообщения (ОБ)

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

с) Правила языка программирования (УСЛ)  

Для компиляторов должны быть описаны правила языка путем ссылки на соответствующую документацию (например, ИСО 7185 для языка ПАСКАЛЬ).

6.5.3 Данные (ОБ)

a) Входные данные (УСЛ)

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

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

b) Вспомогательные данные (УСЛ)

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

c) Выходные данные (ОБ)

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

d) Промежуточные данные (УСЛ)

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

е) Ограничения на данные (УСЛ)