Перейти к содержанию

ЕСПД: стандарты ГОСТ 19 на программную документацию

Единая система программной документации — комплекс стандартов серии ГОСТ 19, который делает для программ то же, что ЕСКД для изделий: задаёт виды документов, их коды, обозначения и стадии разработки. Кратко — что в него входит и какие документы нужны на прошивку по ЕСПД.

Обновлено Редакция GAW

ЕСПД (Единая система программной документации) — комплекс межгосударственных стандартов с номерами ГОСТ 19.xxx, которые устанавливают правила разработки, оформления и обращения программ и программной документации (ГОСТ 19.001-77, п. 1.1). Цели — унифицировать программные изделия для обмена и повторного использования, снизить трудоёмкость разработки и сопровождения и автоматизировать выпуск документации. Правила ЕСПД распространяются на программы для вычислительных машин, комплексов и систем независимо от назначения, то есть и на прошивки микроконтроллеров.

Коротко

Серия
ГОСТ 19.xxx
Введены
с 1 января 1980 г.
Групп стандартов
10 (коды 0–9)
Видов программ
2: компонент и комплекс
Текст программы
код документа 12
Стадий разработки
5

Группы стандартов (ГОСТ 19.001, п. 3.1)

КодГруппа
0общие положения
1основополагающие стандарты
2правила выполнения документации разработки
3правила выполнения документации изготовления
4правила выполнения документации сопровождения
5правила выполнения эксплуатационной документации
6правила обращения программной документации
7, 8резервные
9прочие стандарты

Обозначение стандарта строится так же, как в ЕСКД: «ГОСТ 19», после точки — код группы, затем двузначный номер в группе и через тире год регистрации. ГОСТ 19.101-77 — первый стандарт основополагающей группы 1, зарегистрированный в 1977 году.

Виды программ и документов (ГОСТ 19.101)

Программы делят на компоненты — программы, выполняющие законченную функцию и применяемые самостоятельно или в составе комплекса, — и комплексы из двух и более компонентов (табл. 1). Документы и их коды — в таблице 4 стандарта:

КодДокументЧто содержит
—спецификациясостав программы и документации на неё
05ведомость держателей подлинниковгде хранятся подлинники
12текст программызапись программы с комментариями
13описание программылогическая структура и функционирование
20ведомость эксплуатационных документовперечень эксплуатационных документов
30формулярхарактеристики, комплектность, сведения об эксплуатации
31описание примененияназначение, область применения, ограничения
32руководство системного программистапроверка, настройка под условия применения
33руководство программистасведения для эксплуатации программы
34руководство операторапорядок общения оператора с системой
35описание языкасинтаксис и семантика языка
46руководство по техническому обслуживаниютестовые и диагностические программы
51программа и методика испытанийчто и как проверяют при испытаниях
81пояснительная запискаалгоритм, обоснование технических решений
90–99прочие документы—

Обязательность документа зависит от стадии и вида программы: на рабочем проекте обязательны спецификация и, для компонента, текст программы; необходимость остальных определяют при утверждении технического задания. Отдельные документы, кроме ведомости эксплуатационных документов и формуляра, разрешено объединять (п. 2.6).

Стадии разработки (ГОСТ 19.102)

  1. Техническое задание.
  2. Эскизный проект.
  3. Технический проект.
  4. Рабочий проект.
  5. Внедрение.

Вторую стадию допускается исключать, а в технически обоснованных случаях — вторую и третью. Содержание технического задания задаёт ГОСТ 19.201-78: введение, основания и назначение разработки, требования к программе (функциональные характеристики, надёжность, условия эксплуатации, технические средства, совместимость), требования к документации, технико-экономические показатели, стадии и этапы, порядок контроля и приёмки.

Обозначение и оформление документа

По ГОСТ 19.103-77 обозначение программного документа складывается из групп: код страны и код организации-разработчика, регистрационный номер программы, номер издания, код вида документа по таблице 4, номер документа этого вида и номер части. Группы разделяют точками, пробелами и дефисами. Номер редакции спецификации совпадает с номером издания программы.

Каждый программный документ по ГОСТ 19.105-78 состоит из титульной части (лист утверждения и титульный лист), информационной части (аннотация и содержание), основной части и части регистрации изменений.

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

ЕСПД работает в паре с ЕСКД (ГОСТ серии 2): на изделие с микроконтроллером оформляют схему по ГОСТ 2.702 и программные документы по ГОСТ 19. Основополагающие стандарты ЕСПД введены с 1 января 1980 года и переизданы в 2010 году; ГОСТ 19.101-77 действует с изменением № 1 1981 года. Как организовать сам код прошивки, рассказывает раздел «Программирование».

Частые вопросы

Какие документы на программу обязательны по ЕСПД?

По таблице 4 ГОСТ 19.101-77 на стадии «Рабочий проект» обязательны спецификация — для комплекса всегда, для компонента, если он применяется самостоятельно, — и текст программы (код 12) для компонента. Остальные документы — описание программы, руководство оператора, программа и методика испытаний и другие — составляют, если их необходимость определена при утверждении технического задания.

Действуют ли стандарты ЕСПД?

Стандарты серии 19 введены в 1980 году и переиздавались в 2010 году. Применять ли их в конкретном проекте, определяют договор и техническое задание: если заказчик требует документацию по ЕСПД, её оформляют по этим стандартам.

Чем ЕСПД отличается от ЕСКД?

ЕСКД (стандарты серии 2) регулирует конструкторскую документацию на изделия — схемы, чертежи, спецификации. ЕСПД (серия 19) — документацию на программы для вычислительных машин. На прибор с микроконтроллером обычно оформляют обе: схему по ГОСТ 2.702 и текст программы по ГОСТ 19.

Источники

  1. ГОСТ 19.001-77. ЕСПД. Общие положения — дата введения 01.01.1980; разд. 1 — назначение ЕСПД; разд. 2 — область распространения и состав; п. 3.1 — таблица групп 0–9; п. 3.2 — структура обозначения стандарта ЕСПД
  2. ГОСТ 19.101-77. ЕСПД. Виды программ и программных документов (с изменением № 1) — табл. 1 — компонент и комплекс; табл. 2 — виды программных документов; табл. 3 — эксплуатационные документы; табл. 4 — коды видов документов и обязательность по стадиям; п. 2.6 — объединение документов
  3. ГОСТ 19.102-77. ЕСПД. Стадии разработки — пять стадий: техническое задание, эскизный проект, технический проект, рабочий проект, внедрение; допускается исключать вторую, а в обоснованных случаях вторую и третью стадии
  4. ГОСТ 19.103-77. ЕСПД. Обозначения программ и программных документов — структура регистрационного обозначения: код страны и организации, регистрационный номер, номер издания, код вида документа, номер документа и части
  5. ГОСТ 19.105-78. ЕСПД. Общие требования к программным документам — части документа: титульная (лист утверждения и титульный лист), информационная (аннотация и содержание), основная, регистрация изменений
  6. ГОСТ 19.201-78. ЕСПД. Техническое задание. Требования к содержанию и оформлению — п. 1.4 и разд. 2 — разделы ТЗ: введение, основания, назначение, требования к программе, к документации, технико-экономические показатели, стадии и этапы, порядок контроля и приёмки

Нашли ошибку?