Какие документы должен передать подрядчик промышленного ПО при сдаче?

Что происходит, если система работает, а документы так и не пришли?

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

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

• ПЛК заменили, тег нужно переназначить, но никто не находит прежнюю точку ввода-вывода или регистр
• Производственный отчёт нужно изменить, но никто не записал, какие таблицы базы он читает и какое правило агрегации применяет
• Инженер исходного подрядчика ушёл с объекта, и предприятие не может обучить нового оператора по тем материалам, что реально есть на руках
• Следующему подрядчику поручают расширение, и он вынужден сначала восстановить адреса, экраны и интерфейсы, прежде чем начать новую работу
• Возникает спор по сопровождению, и нет ни скользящего перечня работ, ни годового отчёта по обслуживанию, который показал бы, что фактически сделано

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

Какие четырнадцать документов входят в комплект сдачи?

Полный комплект документации промышленного проекта насчитывает четырнадцать видов: проектное предложение, техническое задание, спецификация, таблица распределения входов-выходов, таблица адресов, схема сети, описание проектирования экранов, руководство оператора, описание таблиц базы данных, спецификация интерфейсов передачи данных, протокол испытаний, приёмочные материалы, перечень работ по обслуживанию, годовой отчёт по обслуживанию. Плоский список имён файлов заказчику не помогает проверить коробку. Группировка по вопросу, на который отвечает каждая группа, — помогает.

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

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

Что заказчику проверить до подписи акта сдачи?

Подпись на приёмочном акте закрывает проект для подрядчика. Для предприятия она открывает период, в котором документы должны держаться сами. Вопросы ниже можно задать на совещании по сдаче; если ответ на любой из них — «пришлём позже», этот пункт ещё не передан.

• Каждый из четырнадцати видов назван в техническом задании, или в договоре стоит только слово «документация» без перечня?
• По каждому названному документу это исполнительная версия, совпадающая с установленными входами-выходами, адресами, экранами и интерфейсами?
• Человек, который не участвовал в проекте, может по руководству оператора отработать смену, не звоня подрядчику?
• В протоколе испытаний указаны критерий, метод, результат и дата, чтобы третий человек отличил «принято» от «не принято»?
• В описании таблиц базы и в спецификации интерфейсов названы таблицы, поля, направления и владелец НСИ?
• Перечень работ по обслуживанию и годовой отчёт по обслуживанию уже есть в рабочем шаблоне, чтобы у работ следующего года была база сравнения?
• Кто после сдачи держит редактируемые исходники — предприятие или только PDF, который хранит подрядчик?

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

На каком языке и в каком формате передавать документы?

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

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

• Рабочий язык совещаний и постоянного окна связи — инженер со знанием русского, закреплённый на весь проект, а не переводчик, который подключается один раз
• Язык спецификации и руководства оператора — русский для персонала, который ими пользуется; файл, у которого переведена обложка, а тело осталось на другом языке, сданным не считается
• Формат файлов — редактируемый исходник (таблица, чертёж, документ) плюс подписанный PDF для архива; указать, какие документы обязательны в обоих видах
• Учёт редакций — у каждого документа есть версия, дата и метка, отличающая проектный выпуск от исполнительной версии

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