ГОСТ 19.504-79 PDF

Полное наименование и описание

ГОСТ 19.504-79 «Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению». Стандарт устанавливает обязательные требования к структуре, содержанию и оформлению документа «Руководство программиста», входящего в состав эксплуатационной документации программного обеспечения в соответствии с ЕСПД (Единой системой программной документации).

Аннотация

Документ задаёт минимальный состав разделов и общие правила оформления «Руководства программиста» (назначение и условия применения программы, характеристика программы, обращение к программе, входные и выходные данные, сообщения и т.д.), допускает объединение разделов в зависимости от особенностей программы и определяет обязательные элементы информационной части (аннотация, содержание и пр.).

Общая информация

• Статус: Действующий (по доступным справочным источникам стандарт числится как действующий документ ЕСПД).
• Дата публикации: введён в действие 01.01.1980 (принят постановлением от 12.01.1979; в тексте приводятся также последующие издания/переиздания).
• Организация-издатель: Межгосударственный стандарт / Госстандарт (издания и переиздания публиковались специализированными издательствами стандартов, в справочных записях отмечено переиздание 2010 г.).
• ICS / категории: 35.080 (Программное обеспечение); КГС Т55 (система административно-управленческой документации, документооборота, организация архивного дела).
• Редакция / версия: ГОСТ 19.504-79 (основной текст 1979/1980 г.) с Изменением №1 (ИУС 11-81); в справочных описаниях упоминаются переиздания/переиздания текста в 2010 г.
• Количество страниц: краткий стандарт — около 3 страниц (в большинстве комплектных описаний указывается 3 стр.).

Область применения

Стандарт применяется при разработке эксплуатационной документации программного обеспечения и устанавливает требования конкретно для документа «Руководство программиста», определённого в ГОСТ 19.101‑77. Он предназначен для использования организациями-разработчиками ПО, техническими писателями и службами сопровождения при оформлении и подготовке руководств к передаче пользователям и в архив.

Ключевые темы и требования

• Обязательные разделы «Руководства программиста»: назначение и условия применения программы; характеристика программы; обращение к программе; входные и выходные данные; сообщения и пояснения; при необходимости — дополнительные разделы или объединение разделов.
• Требования к оформлению и составу информационной части: аннотация и содержание являются обязательными элементами; унифицированные правила заголовков, нумерации и представления технической информации.
• Соответствие ЕСПД: документ часть серии ГОСТ 19.x — набор стандартов, регламентирующих разные виды эксплуатационной документации для программных продуктов.
• Указание на изменения: в текст стандарта были внесены корректировки (в том числе Изменение №1, отражённое в справочных изданиях).

Применение и пользователи

Пользователями стандарта являются программисты, разработчики ПО, технические писатели, руководители отделов сопровождения, заказчики программных комплексов и архивы организаций. Стандарт применяется при подготовке руководств, сопровождающих программные продукты, в ходе ввода в эксплуатацию и при передаче ПО между организациями.

Связанные стандарты

Стилистически и по содержанию ГОСТ 19.504-79 связан с другими стандартами серии ЕСПД: ГОСТ 19.101-77 (общее устройство эксплуатационной документации), ГОСТ 19.503-79 (Руководство системного программиста), ГОСТ 19.505-79 (Руководство оператора), ГОСТ 19.502-78 (Описание применения) и др.; эти документы образуют комплект правил по оформлению и составу программной документации.

Ключевые слова

ЕСПД, руководство программиста, программная документация, форматирование, содержание, ГОСТ 19.504-79, эксплуатационная документация, 35.080.

FAQ

В: Что это за стандарт?

О: ГОСТ 19.504-79 — межгосударственный стандарт, определяющий требования к содержанию и оформлению документа «Руководство программиста» в составе эксплуатационной документации программного обеспечения.

В: Что он регулирует?

О: Регламентирует состав разделов и правила оформления «Руководства программиста» (информационная часть, структура разделов, основные сведения о назначении, характеристике, обращении к программе, входных/выходных данных и сообщениях).

В: Кто обычно использует?

О: Программисты, технические писатели, специалисты по сопровождению ПО, организации‑разработчики и заказчики, а также архивы и службы качества, отвечающие за комплектность и соответствие документации установленным требованиям.

В: Он актуален или заменён?

О: По доступной справочной информации ГОСТ 19.504-79 числится как действующий документ и имеет по крайней мере одно официальное изменение (Изменение №1, ИУС 11-81). При этом в ряде справочников отмечены переиздания/переизложение текста в более поздние годы; прямого указания на полностью заменяющий документ в открытых источниках не обнаружено.

В: Это часть серии?

О: Да — стандарт входит в серию Единая система программной документации (ГОСТ 19.x), где каждый стандарт регламентирует оформление и содержание конкретного вида эксплуатационной документации.

В: Какие ключевые слова?

О: ЕСПД, руководство программиста, руководство программиста ГОСТ, программная документация, оформление документации, 35.080.