РУКОВОДСТВО
ПРОГРАММИСТА.
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ
Настоящий стандарт устанавливает требования к содержанию и
оформлению программного документа «Руководство программиста», определённого ГОСТ
19.101-77.
Стандарт полностью соответствует СТ СЭВ
2095-80.
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Структуру и оформление документа устанавливают в соответствии
с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является
обязательным.
1.2. Руководство программиста должно содержать следующие разделы:
·
назначение
и условия применения программ;
·
характеристика
программы;
·
обращение
к программе;
·
входные
и выходные данные;
·
сообщения.
В зависимости от особенностей документы допускается объединять
отдельные разделы или вводить новые.
2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе «Назначение и условия применения
программ» должны быть указаны назначение и функции, выполняемые программой,
условия, необходимые для выполнения программы (объем оперативной памяти,
требования к составу и параметрам периферийных устройств, требования к
программного обеспечению и т.п.).
2.2. В разделе «Характеристика программы» должно
быть приведено описание основных характеристик и особенностей программы
(временные характеристики, режим работы, средства контроля правильности
выполнения и самовосстанавливаемости программы и
т.п.).
2.3. В разделе «Обращение к программе» должно быть приведено
описание процедур вызова программы (способы передачи управления и параметров
данных и др.).
2.4. В разделе «Входные и выходные данные» должно быть приведено
описание организации используемой входной и выходной информации и, при
необходимости, ее кодирования.
2.5. В разделе «Сообщения» должны быть указаны тексты сообщений,
выдаваемых программисту или оператору в ходе выполнения программы, описание их
содержания и действий, которые необходимо предпринять по этим сообщениям.
2.6. В приложении к руководству программиста могут быть приведены
дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).