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

ГОСТ 19.504-79 Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению. Unified system for program documentation. Programmer's guide. Requirements for contents and form of presentation. Пересмотр от 16.07.2020.

Руководство программиста по ГОСТ 19.504-79

Руководство программиста по ГОСТ 19.504-79

Руководство программиста по ГОСТ 19.504-79Руководство программиста по ГОСТ 19.504-79 - диаграмма Гантта

Смотрите:
Общие положения
Содержание разделов

Общие положения

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

Составление информационной части (аннотации 0 Аннотация [из п. 1.1 ГОСТ 19.504-79] и содержания) является обязательным [из п. 1.1 ГОСТ 19.504-79]

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

В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые [из п. 1.2 ГОСТ 19.504-79]

Содержание разделов

Смотрите:
Назначение и условия применения программ
Характеристика программы
Обращение к программе
Входные и выходные данные
Сообщения
Приложения

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

В разделе «Назначение и условия применения программ» должны быть указаны назначение 1.1 Назначение программы [из п. 2.1 ГОСТ 19.504-79] и функции, выполняемые программой 1.2 Функции, выполняемые программой [из п. 2.1 ГОСТ 19.504-79], условия, необходимые для выполнения программы 1.3 Условия, необходимые для выполнения программы [из п. 2.1 ГОСТ 19.504-79] (объем оперативной памяти 1.3.1 Объем оперативной памяти [из п. 2.1 ГОСТ 19.504-79], требования к составу и параметрам периферийных устройств 1.3.2 Требования к составу и параметрам периферийных устройств [из п. 2.1 ГОСТ 19.504-79], требования к программному обеспечению 1.3.3 Требования к программному обеспечению [из п. 2.1 ГОСТ 19.504-79] и т.п.) [из п. 2.1 ГОСТ 19.504-79]

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

В разделе «Характеристика программы» должно быть приведено описание основных характеристик и особенностей программы 2.1 Описание основных характеристик и особенностей программы [из п. 2.2 ГОСТ 19.504-79] (временные характеристики 2.1.1 Временные характеристики [из п. 2.2 ГОСТ 19.504-79], режим работы 2.1.2 Режим работы [из п. 2.2 ГОСТ 19.504-79], средства контроля правильности выполнения и самовосстанавливаемости программы 2.1.3 Средства контроля правильности выполнения и самовосстанавливаемости программы [из п. 2.2 ГОСТ 19.504-79] и т.п.) [из п. 2.2 ГОСТ 19.504-79]

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

В разделе «Обращение к программе» должно быть приведено описание процедур вызова программы 3.1 Описание процедур вызова программы [из п. 2.3 ГОСТ 19.504-79] (способы передачи управления 3.2 Способы передачи управления [из п. 2.3 ГОСТ 19.504-79] и параметров данных 3.3 Способы передачи параметров данных [из п. 2.3 ГОСТ 19.504-79] и др.) [из п. 2.3 ГОСТ 19.504-79]

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

В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной 4.1 Описание организации входной информации [из п. 2.4 ГОСТ 19.504-79] и выходной информации 4.2 Описание организации выходной информации [из п. 2.4 ГОСТ 19.504-79] и, при необходимости, ее кодирования 4.3 Описание кодирования входной информации [из п. 2.4 ГОСТ 19.504-79] 4.4 Описание кодирования выходной информации [из п. 2.4 ГОСТ 19.504-79] [из п. 2.4 ГОСТ 19.504-79]

Сообщения

В разделе «Сообщения» должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы 5.1 Тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы [из п. 2.5 ГОСТ 19.504-79], описание их содержания 5.2 Описание содержания сообщений [из п. 2.5 ГОСТ 19.504-79] и действий, которые необходимо предпринять по этим сообщениям 5.3 Описание действий, которые необходимо предпринять по сообщениям [из п. 2.5 ГОСТ 19.504-79] [из п. 2.5 ГОСТ 19.504-79]

Приложения

В приложении 6 Приложения [из п. 2.6 ГОСТ 19.504-79] к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.) [из п. 2.6 ГОСТ 19.504-79]

«Техническая документация»

Связь по эл. почте admin @ tdocs . su (без пробелов), тел. +7(967) 044-84-77 или в форме Контакты.

Copyright © «Техническая документация» 2008. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика