3.6 Раздел «4 инструкции по использованию программы»

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

Раздел должен содержать два подраздела:

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

б) 4.2 Руководство программиста.

Эти подразделы выполняются в соответствии с требованиями ГОСТ 19.504-79 и ГОСТ 19.505-79. Некоторые требования к содержанию этих документов очень похожи друг на друга. В данном случае, поскольку оба руководства помещаются в одном документе, ГОСТ разрешает не повторять одно и то же несколько раз. Но не стоит забывать и то, что к описанию вроде бы одинаковых пунктов следует подходить с разных позиций: оператора и программиста. Если оператору достаточно знать интерфейс программы и приёмы работы с ней, то программист должен понимать суть программы, основные принципы, заложенные при её создании. Программисту предстоит не только устанавливать и настраивать программу, но и, возможно, модернизировать её.

3.6.1 Подраздел «4.1 Руководство оператора» может содержать следующие пункты:

а) 4.1.1 Назначение программы;

б) 4.1.2 Условия выполнения программы;

в) 4.1.3 Выполнение программы;

г) 4.1.4 Сообщения оператору.

В пункте «4.1.1 Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и её эксплуатации.

В пункте «4.1.2 Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).

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

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

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

3.6.2 Подраздел «4.2 Руководство программиста» может содержать следующие пункты:

а) 4.2.1 Назначение и условия применения программы;

б) 4.2.2 Характеристика программы;

в) 4.2.3 Обращение к программе;

г) 4.2.4 Входные и выходные данные;

д) 4.2.5 Сообщения.

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

В разделе «4.2.2 Характеристика программы» должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режимы работы, средства защиты программы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).

В разделе «4.2.3 Обращение к программе» должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.), методика установки и снятия программы, если это необходимо.

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

В разделе «4.2.5 Сообщения» должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.

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