ГОСТ 19.504-79
МЕЖГОСУДАРСТВЕННЫЙ стандарт
ЕДИНАЯ СИСТЕМА
ПРОГРАММНОЙ ДОКУМЕНТАЦИИ
РУКОВОДСТВО ПРОГРАММИСТА
ТРЕБОВАНИЯ К
СОДЕРЖАНИЮ
И ОФОРМЛЕНИЮ
|
|
Москва Стандартинформ 2010 |
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
|
Единая система программной документации РУКОВОДСТВО ПРОГРАММИСТА Требования к содержанию и оформлению Unified system for program
documentation. |
ГОСТ |
Издание (январь 2010 г.) с Изменением № 1, утвержденным в сентябре 1981 г. (ИУС11-81).
Постановлением Государственного комитета СССР по стандартам от 12 января 1979 г. № 74 дата введения установлена
01.01.80
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа "Руководство программиста", определенного ГОСТ 19.101-77.
Стандарт полностью соответствует СТ СЭВ 2095-80.
(Измененная редакция, Изм. № 1).
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным.
1.2. Руководство программиста должно содержать следующие разделы: назначение и условия применения программы;
характеристики программы; обращение к программе; входные и выходные данные; сообщения.
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе "Назначение и условия применения программы" должны быть указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т. п.).
2.2. В разделе "Характеристики программы" должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т. п.).
2.3. В разделе "Обращение к программе" должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.).
2.4. В разделе "Входные и выходные данные" должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее кодирования.
2.5. В разделе "Сообщения" должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям.
2.6. В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.).