Руководство оператора

Аннотация и содержание обязательны.

Руководство оператора должно содержать следующие разделы:

• Назначение программы - сведения о назначении и информация, достаточная ля понимания функций программы и ее эксплуатации.

• Условия выполнения программы - условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).

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

• Сообщения оператору - тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующих действий оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).

В зависимости от особенностей документа допускается объединять отдельные разделы и вводить новые.

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

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

Описание языка

Аннотация и содержание обязательны.

Описание языка должно содержать следующие разделы:

• Общие сведения - назначение и описание общих характеристик языка, его возможностей, областей применения и другие сведения

• Элементы языка - описание синтаксиса и семантики базовых и составных элементов языка.

Допускается вводить разделы:

• Способы структурирования программы - способы вызова процедур передачи управления и другие элементы структурирования программы.

• Средства обмена данными - описание языковых средств обмена данными (например, средства ввода-вывода, внутреннего обмена данными и т.п.).

• Встроенные элементы - описание встроенных в язык элементов (например, функции, классы и т.п.) и правила их использования.

• Средства отладки программы - описание имеющихся в языке средств отладки программ, семантики этих средств, даны рекомендации по их применению.

В зависимости от особенностей языка допускается объединять отдельные разделы и вводить новые.

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

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

Руководство по техническому обслуживанию

Аннотация и содержание обязательны.

Руководство по техническому обслуживанию должно содержать следующие разделы:

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

Общие указания - порядок технического обслуживания, указания по организации и особенностям его проведения.

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

Описание функций:

• максимальный состав технических средств, проверяемых этой программой;

• описание совместного функционирования технических средств и программы с указанием метода обработки ошибок;

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

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

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

11