allgosts.ru35.080 Программное обеспечение35 ИНФОРМАЦИОННЫЕ ТЕХНОЛОГИИ

ГОСТ 19.504-79 Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению

Обозначение:
ГОСТ 19.504-79
Наименование:
Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению
Статус:
Действует
Дата введения:
01.01.1980
Дата отмены:
-
Заменен на:
-
Код ОКС:
35.080

Текст ГОСТ 19.504-79 Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению


ГОСТ 19.504-79

Группа Т55


МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ


Единая система программной документации

РУКОВОДСТВО ПРОГРАММИСТА


Требования к содержанию и оформлению


Unified system for program documentation. Programmer's guide. Requirements for contents and form of presentation


МКС 35.080

Дата введения 1980-01-01

Постановлением Государственного комитета CCCР по стандартам от 12 января 1979 г. N 74 дата введения установлена 01.01.80

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа "Руководство программиста", определенного ГОСТ 19.101-77.

Стандарт полностью соответствует СТ СЭВ 2095-80*.

________________

* Доступ к международным и зарубежным документам, упомянутым в тексте, можно получить, обратившись в Службу поддержки пользователей. - .

(Измененная редакция, Изм. N 1).

1. ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным.

1.2. Руководство программиста должно содержать следующие разделы:

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

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

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

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

сообщения.

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

2. СОДЕРЖАНИЕ РАЗДЕЛОВ

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

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

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

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

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

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

Электронный текст документа

и сверен по:

Единая система программной документации:

Сборник национальных стандартов. -

, 2010