Руководство программиста

Структура и оформление программного документа «Руководство программиста» устанав­ливаются в соответствии с ГOCT 19.504 - 79. Руководство программиста должно содержать следующие разделы:

- назначение и условия применения программ;

- характеристика программы;

- обращение к программе;

- входные и выходные данные;

- сообщения.

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

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

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

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

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

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

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