Электронный фонд правовой
и нормативно-технической документации
ГОСТ 19.504-79 Единая система программной документации (ЕСПД). Руководство программиста. Требования к содержанию и оформлению (с Изменением N 1)
ГОСТ 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. В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).
Доступ к полной версии документа ограничен
Документ «ГОСТ 19 504 79» представляет собой часть Единой системы программной документации (ЕСПД) и содержит требования к содержанию и оформлению руководств программистов. Основное назначение стандарта заключается в унификации подходов к разработке и оформлению программной документации, что обеспечивает её понятность и доступность для пользователей. Сфера применения охватывает как государственные, так и коммерческие организации, занимающиеся разработкой программного обеспечения.
Ключевыми аспектами, регламентируемыми данным стандартом, являются требования к структуре и содержанию документации, а также параметры, которые должны быть учтены при её разработке. В частности, документ определяет методы оформления текстовых и графических материалов, а также правила их согласования и утверждения. Это позволяет обеспечить единообразие в представлении информации и облегчает процесс её восприятия.
Важные технические детали стандарта касаются условий испытаний и оценки качества программной документации. В частности, документ описывает методы тестирования и верификации содержания, что позволяет контролировать соответствие документации установленным требованиям. Также предусмотрены классификации программных продуктов, что помогает в организации и систематизации информации.
Целевой аудиторией данного стандарта являются производители программного обеспечения, специалисты по документации, а также контролирующие органы, занимающиеся проверкой соответствия документации установленным нормам. Это позволяет обеспечить высокое качество документации и её соответствие требованиям, предъявляемым к программным продуктам.
Практическое значение стандарта заключается в его влиянии на безопасность и качество программного обеспечения. Соблюдение требований ГОСТ 19 504 79 способствует улучшению охраны труда, совместимости различных программных продуктов и повышению уровня защищенности информации. Это особенно актуально в условиях растущих требований к безопасности и надежности программных решений.
Изменение N 1, внесенное в документ, уточняет некоторые требования к оформлению и структуре руководств программистов. Основное внимание уделяется улучшению ясности и доступности представляемой информации, что позволяет повысить эффективность работы с документацией. Эти изменения направлены на адаптацию стандарта к современным условиям разработки программного обеспечения и требованиям пользователей.
Описание документа носит справочный характер, достоверность этого материала не гарантируется.
Чтобы получить полный доступ к этому и другим документам, приобретайте доступ к Информационной сети «Техэксперт» - лидеру в области комплексного обеспечения предприятий нормативно-технической документацией.
доступны в системах «Техэксперт» и «Кодекс»
Возможно вас заинтересуют
ГОСТ 19.503-79 Единая система программной документации (ЕСПД). Руководство системного программиста. Требования к содержанию и оформлению (с Изменением N 1)
ГОСТ 19.502-78 Единая система программной документации (ЕСПД). Описание применения. Требования к содержанию и оформлению (с Изменением N 1)
ГОСТ 19.501-78 Единая система программной документации (ЕСПД). Формуляр. Требования к содержанию и оформлению
ГОСТ 19.505-79 Единая система программной документации (ЕСПД). Руководство оператора. Требования к содержанию и оформлению (с Изменением N 1)
ГОСТ 19.506-79 Единая система программной документации (ЕСПД). Описание языка. Требования к содержанию и оформлению (с Изменением N 1)
ГОСТ 19.507-79 Единая система программной документации (ЕСПД). Ведомость эксплуатационных документов (с Изменением N 1)