Эксплуатационная документация на ПО
что входит в комплект и зачем она нужна
Документация — это не только про разработку. Чтобы система действительно работала в боевых условиях, важно, чтобы она сопровождалась понятными, структурированными и актуальными эксплуатационными материалами. После запуска системы важно не только «что она делает», но и как её использовать, сопровождать и восстанавливать при сбоях.
В этой статье мы разберём, из чего состоит эксплуатационная документация, какие документы входят в комплект, как они соотносятся с ГОСТ и ISO и чем дополняют общую структуру проектной документации.
Если вы ещё на стадии архитектуры, полезно также заглянуть в методологию проектирования и системной инженерии, чтобы понимать, как эксплуатационные артефакты встраиваются в жизненный цикл системы.
В этой статье мы разберём, из чего состоит эксплуатационная документация, какие стандарты мы учитываем, и как она соотносится с проектной, конструкторской и учётной документацией, какие стандарты ей соответствуют и как она помогает обеспечить устойчивость работы ПО в реальной среде.
Что такое эксплуатационная документация
Эксплуатационная документация — это комплект документов, предназначенных для:
поддержки работы системы после ввода в эксплуатацию;
обеспечения сопровождения, восстановления и администрирования;
обучения пользователей и обслуживающего персонала;
контроля полноты и актуальности сопроводительных материалов.
Состав эксплуатационной документации
Мы выделяем следующие ключевые элементы:
Ведомость эксплуатационных документов
Назначение: перечень всех эксплуатационных документов с обозначениями, версиями и статусом.
Стандарты: ГОСТ 19.101–77 / Configuration Index
Применение: используется для учёта комплектации, контроля актуальности и подготовки к поставке или аудиту.
Требования к квалификации персонала
Назначение: определяют требования к обучению и компетенциям пользователей, администраторов, технической поддержки.
Аналоги: Training Requirements / Competence Matrix / Roles & Responsibilities
Применение: может входить в SRS, Security Plan или оформляться отдельно в рамках HR-политик или ИБ-документов.
Инструкция по действиям в нештатных ситуациях
Назначение: алгоритмы восстановления после сбоев, действия при отказах ПО, сбоев инфраструктуры и инцидентах.
Стандарты: BCP, DRP, ITIL
Применение: может оформляться как самостоятельный документ или быть частью руководства администратора/безопасности.
Руководство администратора
Назначение: порядок настройки, сопровождения, мониторинга и резервного копирования.
ГОСТ: 19.505–79 (аналог — «Руководство системного программиста»)
Применение: описывает доступы, процедуры сопровождения, управление обновлениями и инфраструктурными компонентами.
Инструкции по эксплуатации аппаратных средств
Назначение: правила эксплуатации оборудования, СХД, периферии, серверов и вычислительной техники.
ГОСТ: 2.601 (ЕСКД)
Применение: могут быть заменены руководствами от производителей, но при необходимости включаются как часть комплекта.
Руководство пользователя
Назначение: пошаговые инструкции по работе с системой, описание интерфейсов, сценарии, подсказки.
ГОСТ: 19.505–79, 34.603–92
Применение: может быть как отдельным документом, так и встроенной справкой в систему.
Что не входит в эксплуатационную документацию
Важно отделять эксплуатационные материалы от других категорий. В комплект не входят:
Ведомости программных документов и формуляры ПО — относятся к учётной документации (ГОСТ 19.103–77, 19.701–90).
Формуляры информационных систем — не предусмотрены в ГОСТ 34, применимы только к программным изделиям.
Паспорта оборудования — оформляются по ГОСТ 2.601 как конструкторская документация и не входят в состав эксплуатационного комплекта как такового.
Перечни поставки — являются частью логистической и контрактной документации, но не эксплуатационного сопровождения.
Зачем это бизнесу
Сокращение времени реакции на инциденты — благодаря готовым сценариям и понятным инструкциям.
Устойчивость при смене команды или подрядчика — новые специалисты быстро включаются в процессы.
Готовность к проверкам и поставкам — наличие актуальных и формализованных комплектов.
Повышение качества поддержки — меньше вопросов со стороны пользователей и администраторов.
Если вы хотите навести порядок в эксплуатационной документации
В Etence мы помогаем:
сформировать структуру эксплуатационных документов под ваш стек;
подготовить шаблоны и сопроводительные материалы;
адаптировать документацию под требования ИТ-безопасности и SLA.
Свяжитесь с нами, чтобы обеспечить системе не только запуск, но и устойчивую, управляемую жизнь после него.
05.05.2025