Что такое ЕСПД и где живут эксплуатационные документы
ЕСПД это единая система программной документации, набор стандартов серии ГОСТ 19 на программы и документы к ним. Головной документ серии, ГОСТ 19.101-77, делит все программные документы на две группы. Первая описывает саму разработку (спецификация, текст программы, описание программы). Вторая это эксплуатационные документы: они рассчитаны на того, кто программу устанавливает, запускает и сопровождает.
Эксплуатационная документация на программное обеспечение отвечает на практические вопросы: как развернуть программу, какие условия ей нужны, что делать оператору и как обслуживать технические средства. Отдельные виды эксплуатационных документов допускается объединять (кроме ведомости и формуляра), если это оговорено в техническом задании.
Какие документы относятся к эксплуатационным по ЕСПД
Каждому виду соответствует свой стандарт серии ГОСТ 19, задающий требования к содержанию и оформлению. Ниже основной перечень эксплуатационных программных документов с назначением.
| Документ | Стандарт | Назначение |
|---|---|---|
| Описание применения | ГОСТ 19.502-78 | Общие сведения о программе: назначение, область и возможности применения, требуемые технические средства |
| Руководство системного программиста | ГОСТ 19.503-79 | Установка, настройка, проверка и обслуживание программы силами системного программиста |
| Руководство программиста | ГОСТ 19.504-79 | Эксплуатация программы специалистом, который работает с ней на уровне разработчика |
| Руководство оператора | ГОСТ 19.505-79 | Порядок работы оператора: запуск, выполнение, сообщения программы |
| Руководство по техническому обслуживанию | ГОСТ 19.508-79 | Обслуживание и проверка работоспособности технических средств под программу |
| Ведомость эксплуатационных документов | ГОСТ 19.101-77 (вид) | Перечень документов, входящих в эксплуатационный комплект программы |
Полный набор для конкретной программы определяется техническим заданием. Для небольшой утилиты хватает описания применения и руководства оператора, для сложного комплекса добавляют руководства программиста и по техническому обслуживанию.
ЕСПД и ЕСКД: программы против изделий
Две системы стандартов легко перепутать, потому что обе про документацию и обе про эксплуатацию. Разница в объекте. ЕСПД (серия ГОСТ 19) описывает программы: код, алгоритмы, работу оператора с софтом. ЕСКД (серия ГОСТ 2) описывает изделия: чертежи, узлы, руководство по эксплуатации железа. Если у вас программно-аппаратный комплекс, документы идут по обеим системам параллельно.
Запрос «эксплуатационная документация на программное обеспечение ГОСТ» почти всегда ведёт именно в серию ГОСТ 19, а не в ЕСКД. Путаница возникает, когда прибор со встроенным ПО ошибочно документируют только по ГОСТ 2. Разницу двух зонтичных понятий мы разбираем в материале про эксплуатационную и техническую документацию, а состав по ЕСКД в статье про эксплуатационную документацию по ГОСТ 2.601.
Как идёт разработка эксплуатационной документации на программный продукт
Разработка эксплуатационной документации на программный продукт стартует с определения перечня по техническому заданию. Дальше инженер описывает условия выполнения программы, порядок установки, действия оператора и сообщения системы. Каждый раздел эксплуатационной документации на программное средство наполняется по своему стандарту, чтобы структура совпадала с требованиями ГОСТ 19.5хх.
Готовый комплект проверяют на полноту: хватает ли сведений для развёртывания без разработчика, описаны ли аварийные ситуации, есть ли ведомость документов. Логика приёмки такая же, как у конструкторских комплектов: подходы к эксплуатационной и рабочей конструкторской документации во многом переносятся и на программную часть.
Чем ЕСПД отличается от ЕСКД?
ЕСПД (серия ГОСТ 19) регулирует документацию на программы, ЕСКД (серия ГОСТ 2) на изделия. Для программно-аппаратного комплекса действуют обе системы: софт документируют по ГОСТ 19, а корпус и электронику по ГОСТ 2.
Какой стандарт задаёт виды эксплуатационных программных документов?
Головной стандарт серии, ГОСТ 19.101-77, устанавливает виды программ и программных документов и относит часть из них к эксплуатационным. Требования к каждому виду детализируют отдельные стандарты серии ГОСТ 19.5хх.
Обязательно ли делать все эксплуатационные документы?
Нет. Конкретный состав эксплуатационной документации на программное средство определяет техническое задание. Отдельные виды разрешается объединять в один документ, кроме ведомости эксплуатационных документов и формуляра.
Чем руководство оператора отличается от руководства программиста?
Руководство оператора (ГОСТ 19.505-79) описывает работу с программой конечного пользователя: запуск, ввод данных, сообщения. Руководство программиста (ГОСТ 19.504-79) рассчитано на специалиста, который эксплуатирует программу на уровне разработчика.
Действуют ли старые ГОСТы серии 19 сейчас?
Да, ключевые стандарты ЕСПД приняты в конце 1970-х и продолжают применяться. При разработке проверяют актуальную редакцию по официальному реестру, так как отдельные документы дополнялись изменениями.
Нужен комплект эксплуатационных документов на программу или программно-аппаратный продукт? Инженеры бюро «Реестр Гарант» помогают определить перечень по ЕСПД, развести его с конструкторской частью и оформить по действующим стандартам. Опишите ваш продукт, и мы подскажем состав документации: разработка конструкторской документации.