ГОСТ 19.504—79 Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению. Unified system for program documentation. Programmer's guide. Requirements for contents and form of presentation. УДК 651.7/.78:681.3.06:002:006.354 МКС 35.080. Редакция от 07.11.2023.
1 Общие положения ГОСТ 19.504-79
1.1 Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105—78.
Составление информационной части (аннотации и содержания) является обязательным [из 1.1 ГОСТ 19.504—79]
1.2 Руководство программиста должно содержать следующие разделы:
- назначение и условия применения программы (1);
- характеристика программы (2);
- обращение к программе (3);
- входные и выходные данные (4);
- сообщения (5).
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые [из 1.2 ГОСТ 19.504—79]
2 Содержание разделов ГОСТ 19.504-79
2.1 В разделе «Назначение и условия применения программы» должны быть указаны назначение (1.1) и функции, выполняемые программой (1.2), условия, необходимые для выполнения программы (1.3) (объем оперативной памяти (1.3.1), требования к составу и параметрам периферийных устройств (1.3.2), требования к программному обеспечению (1.3.3) и т.п.) [из 2.1 ГОСТ 19.504—79]
2.2 В разделе «Характеристика программы» должно быть приведено описание основных характеристик и особенностей программы (2.1) (временные характеристики (2.1.1), режим работы (2.1.2), средства контроля правильности выполнения и самовосстанавливаемости программы (2.1.3) и т.п.) [из 2.2 ГОСТ 19.504—79]
2.3 В разделе «Обращение к программе» должно быть приведено описание процедур вызова программы (3.1) (способы передачи управления (3.2) и параметров данных (3.3) и др.) [из 2.3 ГОСТ 19.504—79]
2.4 В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной (4.1) и выходной информации (4.2) и, при необходимости, ее кодирования (4.3) и (4.4) [из 2.4 ГОСТ 19.504—79]
2.6 В приложении (6) к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.) [из 2.6 ГОСТ 19.504—79]
