Как контролировать версии проектной документации
Контроль версий проектной документации нужен для того, чтобы у каждого участника в конкретный момент был однозначный ответ на четыре вопроса: какой документ действует сейчас, какая редакция была заменена, почему произошло изменение и кому новая версия уже выдана. Для этого каждому документу назначают устойчивый идентификатор и редакцию, ведут единый реестр статусов, выпускают связанные изменения одним пакетом и отдельно фиксируют замену ранее переданных файлов.
Главная практическая проблема возникает, когда проект содержит несколько технически правдоподобных файлов и по имени или дате невозможно понять, какой из них использовать. Проектировщик может работать с новой редакцией, проверяющий — с предыдущей, а подрядчик — с ещё более ранней. Поэтому версионный контроль должен управлять не только хранением файлов, но и их статусом, выдачей и заменой у конкретных получателей.
Идентификатор и редакция документа
У каждого проектного документа должен быть однозначный признак, позволяющий отличить сам документ от его редакций. Наименование файла для этой задачи ненадёжно: его можно переименовать, скопировать или сохранить в другую папку. Поэтому в реестре связывают устойчивый идентификатор документа с конкретной редакцией, датой и текущим статусом.
Редакция показывает состояние одного и того же документа во времени. Если план был выпущен, затем скорректирован после замечаний, это не два независимых плана, а последовательные состояния одного документа. В реестре должно быть видно, какая редакция действует сейчас и какую она заменила.
Дата полезна как дополнительный признак, но не должна быть единственным способом определить актуальность. Более поздний файл может оказаться параллельной рабочей копией, которая ещё не прошла проверку и не была выпущена. Поэтому номер или обозначение редакции всегда рассматривают вместе со статусом.
Единый реестр статусов
Реестр проектных документов связывает идентификатор, редакцию и состояние документа. Без такого реестра участникам приходится восстанавливать актуальность по папкам, переписке и именам файлов, а это особенно рискованно при большом количестве последовательных изменений.
Практически полезно различать несколько состояний документа:
- рабочий — редакция ещё разрабатывается и не должна автоматически использоваться как выпущенная;
- на проверке — документ передан для согласования или проверки, но его статус ещё может измениться;
- выпущен — редакция принята для соответствующего этапа использования;
- заменён — документ остаётся в истории, но вместо него действует более новая редакция.
Статус должен изменяться управляемо. Если рабочую копию отправили одному участнику для предварительного просмотра, это ещё не означает, что она стала действующей для всей команды. И наоборот, после официальной замены предыдущая редакция не должна оставаться среди документов, которые можно по ошибке принять за рабочую.
Пакет изменений
Одно проектное изменение часто затрагивает несколько документов. Например, изменение оборудования может потребовать новой схемы, обновлённой спецификации и корректировки связанного расчёта. Если эти документы выпускать независимо без общей связи, у участников легко появляются смешанные комплекты: новый план со старой спецификацией или новая спецификация со старой схемой.
Поэтому существенное изменение лучше оформлять как пакет затронутых документов. В нём фиксируют причину изменения, перечень документов и их новые редакции. Тогда можно проверить не только то, что каждый файл обновлён отдельно, но и то, что все связанные документы относятся к одному состоянию решения.
Пакет особенно важен после междисциплинарных корректировок. Если новый параметр из одного раздела используется в другом, обе стороны должны перейти на согласованные редакции. Выпуск только первичного документа оставляет прежнее значение в зависимой документации.
| Что фиксируют | Что это позволяет проверить |
|---|---|
| Причина изменения | Почему появилась новая редакция и с каким проектным решением она связана |
| Перечень затронутых документов | Какие файлы должны измениться совместно |
| Новые редакции | Какое состояние каждого документа входит в пакет |
| Заменяемые редакции | Какие предыдущие документы больше не должны использоваться |
| Получатели | Кому необходимо передать новый согласованный комплект |
Комплекты выдачи и получатели
Версия становится управляемой только тогда, когда известно не только, что она выпущена, но и кому она была передана. Поэтому для каждого комплекта выдачи фиксируют состав документов, их редакции, получателей и статус передачи.
Это особенно важно, когда документацией одновременно пользуются проектировщики, проверяющие и подрядчики. Новая редакция может уже применяться внутри проектной команды, но ещё не быть переданной подрядчику. В такой ситуации нельзя говорить об одной общей актуальной версии без уточнения этапа и получателя.
Например, после корректировки выпущены три новых листа. Если реестр показывает только сам факт выпуска, остаётся неизвестным, получил ли подрядчик эти листы и должен ли он прекратить работу по старым. Комплект выдачи закрывает этот разрыв: он связывает конкретные редакции с конкретной передачей.
При последующем споре или проверке такой учёт позволяет восстановить, какой набор документов находился у конкретного участника на определённом этапе. Без журнала выдачи приходится судить об этом по разрозненной переписке.
Замена ранее выданной редакции
После выпуска новой версии необходимо отдельно управлять старой. Если прежний документ уже передавался другим участникам, одной публикации новой редакции в общей папке недостаточно. Получатель должен понимать, какой именно документ заменён и с какого момента прежнюю версию нельзя использовать для дальнейшей работы.
Для этого применяют уведомление о замене или другую однозначную запись в принятой системе документооборота. В ней связывают старую и новую редакции. Получателю не приходится самостоятельно сравнивать содержимое папки и определять, что изменилось.
Особенно опасна частичная замена комплекта. Например, из пяти взаимосвязанных документов обновлены три. Если два оставшихся действительно не затронуты изменением, это должно быть понятно из пакета. Если они просто забыты, новая выдача создаёт смешанную редакцию.
Контроль замены заканчивается не отправкой нового файла, а подтверждением того, что у получателя имеется согласованный набор действующих документов и прежняя редакция не воспринимается как равнозначная.
Связанные документы
Версионный контроль должен учитывать зависимости между документами. Один изменённый файл редко существует полностью изолированно. Если в нём изменился параметр, который используется в расчёте, спецификации, рабочем чертеже или другом проектном разделе, эти документы нужно проверить на необходимость синхронной замены.
Рабочая последовательность строится от причины изменения. Сначала определяют изменённый параметр или решение. Затем находят документы, которые используют его дальше. После этого для каждого документа устанавливают, требуется ли новая редакция.
Например, оборудование заменили после проверки. Новая позиция уже появилась в проектной схеме и спецификации. Если связанные расчёты продолжают использовать характеристики прежнего оборудования, формально новые версии выпущены, но комплект ещё содержит два состояния одного решения.
Обратная проверка тоже полезна: новую редакцию зависимого документа прослеживают назад до исходного изменения. Если невозможно объяснить, почему она появилась и с каким пакетом связана, версия требует уточнения.
Параллельные рабочие копии
Во время проектирования могут одновременно существовать несколько рабочих копий. Само по себе это не проблема, пока они ясно отделены от выпущенной документации. Риск возникает, когда параллельная рабочая версия выглядит так же убедительно, как действующая, и попадает в обмен между участниками.
Например, один специалист сохранил локальную копию, внёс изменения и отправил её коллеге до общего выпуска. Такая версия может быть новее по времени, но ещё не отражать все связанные корректировки. Если ориентироваться только на дату файла, её легко принять за окончательную.
Поэтому рабочая копия должна иметь понятный статус и не заменять выпущенную редакцию автоматически. После принятия изменения её либо включают в контролируемый выпуск, либо она остаётся промежуточной версией и не используется как основание для дальнейшей выдачи.
Устаревший документ без явной маркировки создаёт противоположную проблему. Он уже не действует, но внешне ничем не отличается от актуального файла. Такие редакции нужно выводить из рабочего пространства или маркировать так, чтобы их невозможно было случайно использовать.
Замена после замечаний
После замечаний эксперта или внутренней проверки особенно важно отделить подготовленную корректировку от уже выпущенной новой редакции. Проектировщик может сначала создать рабочую версию для ответа, затем внести дополнительные исправления и только после этого сформировать окончательный выпуск.
В реестре эти состояния должны различаться. Версия, находящаяся на проверке, ещё может измениться. Только после принятия корректировки ей присваивают соответствующий статус, формируют комплект выдачи и связывают с заменяемой редакцией.
Если замечание затрагивает несколько документов, выпуск также рассматривают как связанный пакет. Например, исправление проектного параметра потребовало обновить расчёт и графическую часть. Нельзя закрывать версионный переход выпуском только одного изменённого листа, если остальные зависимые документы всё ещё находятся в предыдущем состоянии.
Когда после корректировки нужно определить, достаточно ли локальной сверки или изменение распространилось шире, используют отдельную проверку необходимости повторной проверки проекта после изменений.
Архив заменённых редакций
Заменённые версии не следует смешивать с рабочим комплектом, но история изменений должна сохраняться. Архив позволяет восстановить, какой документ действовал раньше, что именно было заменено и к какому пакету изменений относится переход на новую редакцию.
Архив особенно полезен при нескольких последовательных корректировках. Если новый вопрос возник после третьей редакции, можно проследить, в какой момент изменился соответствующий параметр и какие документы менялись вместе с ним.
При этом архив выполняет историческую функцию. Наличие старого файла в архиве не делает его допустимой альтернативой актуальному документу. В рабочем реестре статус такой версии должен оставаться однозначным — заменена.
Критерии управляемой версии
Версионный переход можно считать завершённым, когда по реестру однозначно видна текущая редакция каждого затронутого документа, новая версия связана с причиной и пакетом изменения, заменённые файлы исключены из действующего комплекта, а все получатели получили согласованный набор редакций.
Перед завершением перехода полезно проверить:
- у каждого документа есть устойчивый идентификатор и конкретная редакция;
- для редакции указан её реальный статус;
- изменение связано с причиной и перечнем затронутых документов;
- зависимые документы проверены на необходимость синхронного обновления;
- комплект выдачи содержит согласованные редакции;
- получатели и состояние передачи зафиксированы;
- заменённые версии убраны из рабочего использования или явно маркированы;
- архив позволяет восстановить историю, не создавая конкуренции с актуальным комплектом.
Если изменение оказалось существенным и затронуло несколько взаимосвязанных решений, можно определить объём экспертизы изменений проектной документации. Отдельный риск возникает, когда новая версия вводится без проверки её влияния на связанные документы — такая ситуация рассматривается как изменение проекта без комплексной проверки.
Версионный контроль позволяет установить, какая редакция должна использоваться и как она была передана участникам. Он не подтверждает техническую корректность самой новой версии: для этого требуется содержательная проверка соответствующих проектных решений, расчётов и зависимостей. Если актуальная редакция ключевого документа не определена или отсутствует связанный документ, сначала нужно восстановить контролируемую версионную цепочку и только затем использовать комплект для следующего решения.