ГОСТ 19.503—79 ЕСПД. Руководство системного программиста

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

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

ГОСТ 19.503-79

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

ЕДИНАЯ СИСТЕМА ПРОГРАММНОЙ ДОКУМЕНТАЦИИ

РУКОВОДСТВО

СИСТЕМНОГО ПРОГРАММИСТА

ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ

Издание официальное

Москва

Стандартинформ

2010

УДК 651.7/.78:681.3.06:002:006.354 Группа Т55

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

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

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

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

Unified system for program documentation.

System programmer’s guide.

Requirements for contents and form of presentation

ГОСТ

19.503-79

МКС 35.080

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

01.01.80

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

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

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

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

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

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

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

общие сведения о программе;

структура программы;

настройка программы;

проверка программы;

дополнительные возможности;

сообщения системному программисту.

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

В обоснованных случаях допускается раздел ’’Дополнительные возможности” не приводить, а в наименованиях разделов опускать слово ’’программа” или заменять его на ’’наименование программы”.

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

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

2.1. В разделе “Общие сведения о программе” должны быть указаны назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.

2.2. В разделе “Структура программы” должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.

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

Издание официальное ★

Перепечатка воспрещена

) Издательство стандартов, 1979 © СТАНДАРТИНФОРМ, 2010

Издание (январь 2010 г.) с Изменением № 1, утвержденным в сентябре 1981 г. (ИУС11—81).

С. 2 ГОСТ 19.503-79

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

При необходимости приводят поясняющие примеры.

2.4. В разделе ’’Проверка программы” должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).

2.5. В разделе ’’Дополнительные возможности” должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора.

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

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

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

Категории ОКС

Поиск ГОСТов по категориям Общероссийского Классификатора Стандартов

  • IT, электроника и бытовая техника
  • Добыча и переработка
  • Производство и строительство
  • Промышленность
  • Техника и оборудование
  • Общие положения 01.
  • Услуги, управление и социология 03.
  • Математика, естественные науки07.
  • Здравоохранение11.
  • Охрана окружающей среды13.
  • Метрология и измерения. Физические явления. 17.
  • Испытания. 19.
  • Технология получения изображений. 37.
  • Точная механика. Ювелирное дело. 39.

Классификатор ОКПД 2

поиск кода ОКПД 2 онлайн, все категории классификатора

Статус документа:
действует, введён в действие 01.01.1980
Название на английском языке:
Unified system for program documentation. System programmer’s guide. Requirements for contents and form of presentation
Дата актуализации информации по стандарту:
10.09.2019, в 13:50 (более года назад)
Вид стандарта:
Основополагающие стандарты
Дата начала действия ГОСТа:
1980-01-01
Дата последнего издания документа:
2010-03-04

Коды документа ГОСТ 19.503-79:

Код КГС:
Т55
Код ОКСТУ:
5004;0019
Число страниц:
4
Назначение ГОСТ 19.503-79:
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство системного программиста»
ГРНТИ индекс(ы):
504101
Этот ГОСТ входит в сборник:
Единая система программной документации

Нормативные ссылки из текста ГОСТ 19.503-79:

Ссылки на ГОСТы:

Скачать ГОСТ 19.503-79 вы можете в следующих версиях:

Дата добавленияв версии файла:Загрузок:Размер:Ссылка на страницу загрузки:12/12/2011 02:589830.25 Мб

Поправки и изменения к ГОСТ 19.503-79:

  • Наименование, вид:Датарегистрации:начала действия:Ссылка:
  • Изменение №1 к ГОСТ 19.503-79

    Тип изменения: Текстовое изменение Номер изменения: 1 Регистрационный номер: 4170 Новое значение:

    1981-09-081982-01-01

  • страница 1
  • страница 2

Проект RUGOST1.0 предназначен для помощи IT компаниям в работе с государственными заказчиками. Сайт содержит ГОСТы, примеры разработанных документов по ГОСТ (Техническое задание, ТП,РД), шаблоны документов по ГОСТ. Проект развивается, наполнение сайта будет происходить постепенно.

Содержание сайта будет интересно руководителям проектов, системным архитекторам, техническим писателям.

Все представленные на сайте ГОСТы взяты из открытых, официальных печатных и электронных источников, и поэтому могут содержать ошибки и неточности.

Подробнее…

Введение

Какие бывают ГОСТы?

  1. Международные стандарты (ISO, IEEE Std);
  2. Российские или Советские ГОСТы.

Международные стандарты Международные стандарты применяются для разработки документации международного уровня. Как правило, они не бесплатные, так как разрабатываются не государственными организациями, но, в отличие от наших, разработаны совсем недавно. Тема международных стандартов очень широкая, поэтому она будет рассмотрена в другой статье. Тут же затронуто несколько стандартов, которые тесно связаны с написанием документации. Список основных международных стандартов для написания документации:

  1. IEEE Std 1063-2001 «IEEE Standard for Software User Documentation» — стандарт для написания руководства пользователя;
  2. IEEE Std 1016-1998 «IEEE Recommended Practice for Software Design Descriptions» — стандарт для написания технического описания программы;
  3. ISO/IEC FDIS 18019:2004 «Guidelines for the design and preparation of user documentation for application software» — ещё один стандарт для написания руководства пользователя. В данном документе есть большое количество примеров. Так сказать, это больше похоже на руководство по написанию руководства пользователя. Начинающим специалистам будет особенно полезен;
  4. ISO/IEC 26514:2008 «Requirements for designers and developers of user documentation» — ещё один стандарт для дизайнеров и разработчиков пользователей документации.

Международных стандартов на самом деле очень много и в каждой стране они свои, так как один и тот же стандарт не всегда может подойти и европейским, и азиатским компаниям.

Российские стандарты Российские стандарты разрабатываются на государственном уровне. Они все абсолютно бесплатны и каждый из них легко найти в интернете. Для написания документации на программу используются две серии ГОСТов 19 и 34. Именно о них и будет идти речь дальше.

Чем отличаются ГОСТы серий 19 и 34?

  1. Программа — данные, предназначенные для управления конкретными компонентами системы обработки информации в целях реализации определённого алгоритма.
  2. Программное обеспечение — совокупность программ системы обработки информации и программных документов, необходимых для эксплуатации этих программ.

В ГОСТе 34.003-90 «Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Термины и определения» указано определение:

  1. Организационное;
  2. Методическое;
  3. Техническое;
  4. Математическое;
  5. Программное обеспечение;
  6. Информационное;
  7. Лингвистическое;
  8. Правовое;
  9. Эргономическое.

ГОСТ 34

Серия ГОСТов 34 (ГОСТ 34.ххх Стандарты информационной технологии) состоит:

  1. ГОСТ 34.201-89 Виды, комплектность и обозначения документов при создании автоматизированных систем — данный стандарт устанавливает виды, наименование, комплектность и номера документов. Является одним из основных документов серии ГОСТов 34. По сути, это базовый документ, так что новичкам необходимо ознакомиться с ним в первую очередь.
  2. ГОСТ 34.320-96 Концепции и терминология для концептуальной схемы и информационной базы — настоящий стандарт устанавливает основные понятия и термины концептуальных схем и информационных баз, охватывающие разработку, описание и применение концептуальных схем и информационных баз, манипулирования информацией, а также описание и реализацию информационного процесса. Стандарт определяет роль концептуальной схемы. Положения, изложенные в нём, носят рекомендательный характер и могут использоваться для оценки систем управления базами данных (СУБД). Этот документ не описывает конкретные методы применения средств поддержки концептуальных схем. Описанные в стандарте языки концептуальных схем не следует рассматривать как стандартные.
  3. ГОСТ 34.601-90 Автоматизированные системы. Стадии создания — стандарт устанавливает стадии и этапы создания АС.
  4. ГОСТ 34.603-92 Информационная технология. Виды испытаний автоматизированных систем — стандарт устанавливает виды испытаний АС автономные, комплексные, приёмочные испытаний и опытная эксплуатация) и общие требования к их проведению.
  5. РД 50-34.698-90 Автоматизированные системы. Требования к содержанию документов — один из важнейших документов 34 ГОСТа, так как именно в нём описано содержание практически всех документов, а также описание каждого пункта документа.
  6. ГОСТ Р ИСО/МЭК 8824-3-2002 Информационная технология. Абстрактная синтаксическая нотация версии один — настоящий стандарт является частью абстрактной синтаксической нотации версии 1 (АСН.1) и устанавливает нотацию для спецификации ограничений, определённых пользователем, и табличных ограничений.
  7. ГОСТ Р ИСО/МЭК 10746-3-2001 Управление данными и открытая распределённая обработка. В настоящем стандарте:
    • определено, как специфицируются системы открытой распределённой обработки (ОРО) с использованием понятий, введённых в ГОСТ Р ИСО/МЭК 10746-2;
    • идентифицированы характеристики, по которым системы относятся к системам ОРО.

    В стандарте установлен каркас для координации разработки стандартов по системам ОРО.

    </ul>

  8. ГОСТ Р ИСО/МЭК 15910-2002 Процесс создания документации пользователя программного средства — определяет минимально необходимый процесс создания документации пользователя всех видов для программного средства, имеющего интерфейс пользователя. Данные виды охватывают печатную документацию (например, руководства пользователя и краткие справочные карты), диалоговую (оперативную) документацию, справочный текст («хелпы») и системы диалоговой документации.

Перечень документов 34 ГОСТа

Наименование документа Код Дополнительные указания
ЭП Ведомость эскизного проекта ЭП* ОР
П1 ОР
ЭП, ТП Схема организационной структуры СО ОР Допускается включать в документ П3 или ПВ
С1* ТО Х Допускается включать в документ П9
Схема функциональной структуры С2* ОР При разработке документов СО, С1, С2, С3 на стадии ЭП допускается их включать в документ П1
В9 ТО Х
Схема автоматизации С3* ТО Х
ТО В состав проекта не входят
ТП ТО Х В состав проекта не входят
Ведомость технического проекта ТП* ОР
Ведомость покупных изделий ВП* ОР
В1 ИО
В2 ИО
В3 ТО Х Допускается включать в документ П2
П2 ОР
П3 ОР
П4 ОР
П5 ИО
П6 ИО
ТП П7 ИО
П8 ИО
П9 ТО Для задачи допускается включать в документ 46 по ГОСТ 19.101
ПА ПО
ПБ МО Допускается включать в документы П2, П3 или П4
ПВ ОО
План расположения С8 ТО Х Допускается включать в документ П9
ТО Х
Локальный сметный расчёт Б2 ОР Х
ТП, РД Б1 ОР
С9 ИО Х
РД ДП* ОР
ЭД* ОР Х
Спецификация оборудования В4 ТО Х
В5 ТО Х
ВМ* ИО Х
Массив входных данных В6 ИО Х
РД Каталог базы данных В7 ИО Х
В8 ИО Х
Локальная смета Б3 ОР Х
И1 ОО Х
Технологическая инструкция И2 ОО Х
Руководство пользователя И3 ОО Х
И4 ИО Х
Инструкция по эксплуатации КТС ИЭ ТО Х
Схема соединений внешних проводок С4* ТО Х
С5* ТО Х То же
Таблица соединений и подключений С6 ТО Х
Е1* ТО
Чертёж общего вида ВО* ТО Х
Чертёж установки технических средств СА ТО Х
Схема принципиальная СБ ТО Х
С1* ТО Х
План расположения оборудования и проводок С7 ТО Х
ПГ ОО Х
Общее описание системы ПД ОР Х
ПМ* ОР
Формуляр ФО* ОР Х
Паспорт ПС* ОР Х
*Документы, код которых установлен в соответствии с требованиями стандартов ЕСКД

Примечание к таблице:

  1. В таблице приняты следующие обозначения:
    • ЭП — эскизный проект;
    • ТП — технический проект;
    • РД — рабочая документация;
    • ОР — общесистемные решения;
    • ОО — решения по организационному обеспечению;
    • ТО — решения по техническому обеспечению;
    • ИО — решения по информационному обеспечению;
    • ПО — решения по программному обеспечению;
    • МО — решения по математическому обеспечению.
  2. Знак Х — обозначает принадлежность к проектно-сметной или эксплуатационной документации.
  3. Номенклатуру документов одного наименования устанавливают в зависимости от принятых при создании системы проектных решений.

ГОСТ 19

Серия ГОСТов 19 (ГОСТ 19.ххх Единая система программной документации (ЕСПД)) состоит:

    1. ГОСТ 19.001-77 Общие положения — слишком общий документ, практической пользы он не несёт. Поэтому его можно пропустить.
    2. ГОСТ 19781-90 Термины и определения — хороший список определений в области программного обеспечения систем обработки информации. Кроме как определений больше не содержит ничего.
    3. ГОСТ 19.101-77 Виды программ и программных документов — один из главных документов 19 ГОСТа. Именно с него следует начинать работу с 19 ГОСТом, так как в нём содержится полный перечень и обозначения документов ГОСТа.

Перечень документов 19 ГОСТа

Код Вид документа Стадии разработки
Рабочий проект
компонент комплекс
Спецификация
05 Ведомость держателей подлинников
12 Текст программы
13 Описание программы
20 Ведомость эксплуатационных документов
30 Формуляр
31 Описание применения
32 Руководство системного программиста
33 Руководство программиста
34 Руководство оператора
35 Описание языка
46
51 Программа и методика испытаний
81 Пояснительная записка
90-99 Прочие документы

Условные обозначения:

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

  1. ГОСТ 19.102-77 Стадии разработки — содержит описание стадий разработки. Полезен в образовательных целях. На мой взгляд, особой практической пользы не несёт.
  2. ГОСТ 19.103-77 Обозначения программ и программных документов — содержит описание присвоения номера (кода) документу. Даже после прочтения этого ГОСТа остаётся куча вопросов о том, как же присвоить этот самый номер документу.
  3. ГОСТ 19.104-78 Основные надписи — устанавливает формы, размеры, расположение и порядок заполнения основных надписей листа утверждения и титульного листа в программных документах, предусмотренных стандартами ЕСПД, независимо от способов их выполнения. Так как документы 19 ГОСТа оформляются в рамочках, то данный документ очень важен.
  4. ГОСТ 19.105-78 Общие требования к программным документам — устанавливает общие требования к оформлению программных документов. Требования слишком общие. Как правило для разработки документа этот ГОСТ почти не применяется, так как хватает специального ГОСТа на документ, но для общих знаний в данный ГОСТ все же лучше заглянуть разок.
  5. ГОСТ 19.106-78 Требования к программным документам, выполненным печатным способом — содержит требования к оформлению всех документов 19 ГОСТа.
  6. ГОСТ 19.201-78 Техническое задание, требования к содержанию и оформлению — устанавливает порядок построения и оформления технического задания на разработку программы или программного изделия. Пункты ТЗ 34 ГОСТа и 19 ГОСТа отличаются.
  7. ГОСТ 19.601-78 Общие правила дублирования, учёта и хранения — общие правила дублирования, обращения, учёта и хранения программных документов. В ГОСТе в нескольких пунктах описано как сделать так, чтобы документы не потерялись.
  8. ГОСТ 19.602-78 Правила дублирования, учёта и хранения программных документов, выполн-х печ. Способом — дополнение к ГОСТу 19.601-78.
  9. ГОСТ 19.603-78 Общие правила внесения изменений — устанавливает общие правила внесения изменений в программные документы. По сути, описывает длинный бюрократический алгоритм внесения изменений в документы.
  10. ГОСТ 19.604-78 Правила внесения изменений в программные документы, выполненных печатным способом — описывает порядок работы и заполнения с Листа регистрации изменений.

Список специализированных ГОСТов, то есть в каждом из них описано содержание и требования к определённому документу:

  1. ГОСТ 19.202-78 Спецификация. Требования к содержанию и оформлению;
  2. ГОСТ 19.301-79 Программа и методика испытаний. Требования к содержанию и оформлению;
  3. ГОСТ 19.401-78 Текст программы. Требования к содержанию и оформлению;
  4. ГОСТ 19.402-78 Описание программы;
  5. ГОСТ 19.403-79 Ведомость держателей подлинников;
  6. ГОСТ 19.404-79 Пояснительная записка. Требования к содержанию и оформлению;
  7. ГОСТ 19.501-78 Формуляр. Требования к содержанию и оформлению;
  8. ГОСТ 19.502-78 Описание применения. Требования к содержанию и оформлению;
  9. ГОСТ 19.503-79 Руководство системного программиста. Требования к содержанию и оформлению;
  10. ГОСТ 19.504-79 Руководство программиста. Требования к содержанию и оформлению;
  11. ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению;
  12. ГОСТ 19.506-79 Описание языка. Требования к содержанию и оформлению;
  13. ГОСТ 19.507-79 Ведомость эксплуатационных документов;
  14. ГОСТ 19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и оформлению.

Порядок работы с 19 ГОСТом:

  1. В ГОСТе 19.101-77 выбрать документ и его код согласно стадии разработки.
  2. Согласно ГОСТу 19.103-77 присвоить номер документу.
  3. Затем по ГОСТам 19.104-78 и 19.106-78 оформить документ.
  4. Из специализированного списка ГОСТов следует выбрать тот, который соответствует разрабатываемому документу.

Заключение

ГОСТ — это не страшно и несложно! Главное понять, что нужно написать и какой для этого ГОСТ используется. Наши основные ГОСТы 19 и 34 для написания документации очень старые, но и по сей день актуальны. Написание документации по стандарту снимает множество вопросов между исполнителем и заказчиком. Следовательно, несёт в себе экономию времени и денег.

Скачать ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению (оригинал)

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

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

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

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

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

Unified system for program documentation. System programmer’s guide. Requirements for contents and form of presentation

ГОСТ

19.503-79

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

01.01.80

Издание с Изменением № 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

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

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

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

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

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

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

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

общие сведения о программе;

структура программы;

настройка программы;

проверка программы;

дополнительные возможности;

сообщения системному программисту.

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

В обоснованных случаях допускается раздел «Дополнительные возможности» не приводить, а в наименованиях разделов опускать слово «программа» или заменять его на «наименование программы».

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

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

2.1. В разделе «Общие сведения о программе» должны быть указаны назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.

2.2. В разделе «Структура программы» должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.

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

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

При необходимости приводят поясняющие примеры.

2.4. В разделе «Проверка программы» должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).

2.5. В разделе «Дополнительные возможности» должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора.

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

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

Скачать ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению (оригинал)

Используемые источники:

  • https://allgosts.ru/35/080/gost_19.503-79
  • https://gostexpert.ru/gost/gost-19.503-79
  • http://www.rugost.com/index.php
  • https://docplace.ru/gost34/
  • http://techwrconsult.com/library/19.503

Оцените статью
Рейтинг автора
5
Материал подготовил
Андрей Измаилов
Наш эксперт
Написано статей
116