Смотрите: |
Общие положения
Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным [из п. 1.1 ГОСТ 19.504-79]
Руководство программиста должно содержать следующие разделы:
- назначение и условия применения программы;
- характеристика программы;
- обращение к программе;
- входные и выходные данные;
- сообщения.
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые [из п. 1.2 ГОСТ 19.504-79]
Содержание разделов
Смотрите: |
Назначение и условия применения программы
В разделе «Назначение и условия применения программы» должны быть указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.) [из п. 2.1 ГОСТ 19.504-79]
Характеристика программы
В разделе «Характеристика программы» должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.) [из п. 2.2 ГОСТ 19.504-79]
Обращение к программе
В разделе «Обращение к программе» должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.) [из п. 2.3 ГОСТ 19.504-79]
Входные и выходные данные
В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее кодирования (и 4.4 Описание кодирования выходной информации [из п. 2.4 ГОСТ 19.504-79]) [из п. 2.4 ГОСТ 19.504-79]
Сообщения
В разделе «Сообщения» должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям [из п. 2.5 ГОСТ 19.504-79]
Приложения
В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.) [из п. 2.6 ГОСТ 19.504-79]