Эксплуатационная документация: виды и состав для программ и систем

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

Эксплуатационная документация: виды и состав для программ и систем
Содержание
  1. Что относится к эксплуатационной документации
  2. Какие стандарты регулируют состав и содержание
  3. Виды эксплуатационных документов и их назначение
  4. Состав эксплуатационной документации для программ
  5. Состав эксплуатационной документации для автоматизированной системы
  6. Как определить минимально необходимый комплект
  7. Ведомость эксплуатационных документов
  8. Оформление, версии и сопровождение документов
  9. Частые ошибки при подготовке комплекта
  10. Частые вопросы

Что относится к эксплуатационной документации

Эксплуатационная документация - это комплект документов, по которым систему или программу используют, обслуживают и принимают на баланс уже после разработки. Проектная документация отвечает на вопрос "как это устроено и почему так сделано". Эксплуатационная отвечает на вопросы "как этим пользоваться", "как за этим следить" и "что именно нам передали".

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

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

Какие стандарты регулируют состав и содержание

В России параллельно действует несколько систем стандартов, и каждая задает свой набор эксплуатационных документов. Какую из них применять, определяет предмет разработки и условия договора.

Семейство стандартовДля чего применяютОсновные документы
ГОСТ 19 (ЕСПД)Программы и программные комплексыРуководства оператора, программиста, системного программиста, описание применения, формуляр, ведомость
ГОСТ 34Автоматизированные системыРуководство пользователя, инструкции, паспорт, формуляр, ведомость эксплуатационных документов
ГОСТ 2 (ЕСКД)Изделия с аппаратной частьюРуководство по эксплуатации, паспорт, формуляр, этикетка, ведомость эксплуатационных документов

Виды программных документов перечислены в ГОСТ 19.101-77. Правила для изделий изложены в ГОСТ 2.601, актуальная редакция стандарта действует с 2019 года, а правила выполнения даны в ГОСТ 2.610. Комплектность документов для систем задает ГОСТ 34.201-89. О различиях ЕСПД и ЕСКД читайте в материале ЕСПД и ЕСКД: в чем разница.

Виды эксплуатационных документов и их назначение

Чтобы не запутаться в названиях, удобно держать в голове три группы. В первую входят документы для тех, кто работает в системе. Во вторую - документы для тех, кто ее поддерживает. В третью - документы, которые фиксируют факт передачи и состояние изделия.

Эксплуатационные документы делят на три группы по тому, кто с ними работает.
Эксплуатационные документы делят на три группы по тому, кто с ними работает.
ДокументЧто в немКто читает
Руководство пользователя или оператораПорядок работы с программой, описание операций, сообщенияСотрудники, которые работают в системе
Руководство администратора или системного программистаУстановка, настройка, проверка, сопровождениеАдминистраторы и инженеры сопровождения
Руководство программистаКак обращаться к программе из других программ, интерфейсы, входные и выходные данныеРазработчики интеграций
Описание примененияНазначение программы, условия применения, решаемые задачиРуководители, постановщики задач
Руководство по техническому обслуживаниюКонтрольные проверки, тесты, порядок диагностикиСпециалисты сопровождения
ФормулярОсновные характеристики, комплектность, учет состояния, гарантииЗаказчик, учетные подразделения
ПаспортКраткие сведения об изделии, комплектность, свидетельство о приемкеЭксплуатирующая организация
Ведомость эксплуатационных документовПеречень всех эксплуатационных документов комплектаПриемочная комиссия, архив

Подробные статьи по основным из них: руководство пользователя, руководство администратора и паспорт и формуляр.

Состав эксплуатационной документации для программ

В Единой системе программной документации эксплуатационные документы определены списком. Для типичной программы выбирают из него то, что нужно конкретному продукту, и фиксируют выбор в техническом задании.

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

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

Состав эксплуатационной документации для автоматизированной системы

Для автоматизированных систем перечень шире, потому что в состав системы входят не только программы, но и технические средства, информационное обеспечение, люди и процессы. Комплектность определяется стандартом на виды и обозначения документов и уточняется техническим заданием.

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

Как определить минимально необходимый комплект

Лишние документы тратят бюджет и время, недостающие приводят к замечаниям при приемке. Чтобы найти баланс, пройдите по простой последовательности.

  1. Откройте договор и техническое задание: в них часто прямо перечислены обязательные документы и стандарты.
  2. Определите тип разработки: программа, автоматизированная система или изделие с оборудованием, и выберите семейство стандартов.
  3. Выпишите группы пользователей: кто будет работать, кто администрировать, кто принимать.
  4. Для каждой группы подберите документ из стандарта, который отвечает на ее вопросы.
  5. Согласуйте список с заказчиком и оформите его ведомостью эксплуатационных документов.

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

Ведомость эксплуатационных документов

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

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

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

Оформление, версии и сопровождение документов

Эксплуатационные документы живут столько же, сколько система. Поэтому с самого начала заложите правила: у каждого документа есть версия, дата, ответственный и лист регистрации изменений.

  • Версия документа соответствует версии системы или явно показывает, на какие сборки он распространяется.
  • Изменения вносят через новую редакцию, а не правкой на месте, чтобы можно было восстановить, что действовало ранее.
  • Для всех документов комплекта используют единый стиль: заголовки, нумерацию, подписи таблиц и рисунков.
  • Хранят документы в одном месте, где к ним есть доступ у сопровождающих и приемочной комиссии.

Общие правила оформления текстовых документов собраны в материале об оформлении по ГОСТ 2.105-2019. Они подходят для всех документов комплекта.

Частые ошибки при подготовке комплекта

Типичные проблемы связаны не с формулировками, а с комплектностью и согласованностью. Проверьте комплект по списку.

  • Набор документов выбран по аналогии с чужим проектом, а не по условиям договора.
  • Руководство пользователя и руководство администратора смешаны в одном файле.
  • Ведомость содержит документы, которых нет, и не содержит тех, которые есть.
  • В разных документах одна и та же функция названа по-разному.
  • Не указано, к какой версии системы относится комплект.
  • Формуляр не заполнен или не подписан к моменту приемки.

Дополнительно полезно заранее продумать, как комплект будет приниматься: смотрите разбор процесса в статье об акте приемки работ.

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

Что входит в эксплуатационную документацию?

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

Обязательна ли эксплуатационная документация?

Для госзаказов и работ по договору с условием соответствия ГОСТ - да. Для внутренних проектов обязательность определяет заказчик. На практике без минимального комплекта система плохо переживает смену сотрудников.

Чем эксплуатационная документация отличается от проектной?

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

Сколько документов должно быть в комплекте?

Единого числа нет. Для небольшого приложения хватает руководства пользователя и краткого описания установки, для автоматизированной системы с оборудованием понадобится 6-10 документов. Состав определяют по договору.

Кто готовит эксплуатационную документацию?

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

Читайте также