Приложение 15. Руководство программиста (ГОСТ 19.504-79)
|
Составление информационной части (аннотации и содержания) является обязательным.
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ
В разделе должны быть указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.).
2. ХАРАКТЕРИСТИКИ ПРОГРАММЫ
В разделе должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).
3. ОБРАЩЕНИЕ К ПРОГРАММЕ
В разделе должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.).
4. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ
В разделе должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее кодирования.
5. СООБЩЕНИЯ
В разделе должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
В приложении к документу могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).