Как оформить электронную документацию

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

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

Идентификация документа начинается с его роли в комплекте

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

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

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

Формат выбирают по применимым требованиям, а не по привычке

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

Если соответствующей действующей XML-схемы нет, применяется иной допустимый формат в соответствии с требованиями к электронным документам. Поэтому правило «все сохранить одинаково» может привести к ошибке. Сначала определяется вид документа и наличие применимой схемы, затем выбирается техническая форма его представления. Такой порядок следует из требований к форматам электронных документов, утвержденных приказом Минстроя России от 12.05.2017 № 783/пр.

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

Постановление Правительства Российской Федерации от 05.03.2007 № 145 связывает электронное представление документов с соблюдением требований к их формату. Нарушение применимых требований к формату имеет процедурное значение, поэтому техническую форму комплекта следует проверять до передачи, а не после возникновения проблемы при первичном рассмотрении документов.

Версии документов должны описывать один и тот же актуальный комплект

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

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

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

Сканированные и структурированные документы требуют разных проверок

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

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

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

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

Техническое оформление и содержание проверяются раздельно

Одна из наиболее важных границ — различие между правильным форматом и правильным содержанием. Корректный XML, PDF или другой применимый формат подтверждает только техническую сторону представления в пределах соответствующих требований. Из этого нельзя сделать вывод, что проектное решение, расчет, исходные данные или результат изысканий содержательно верны.

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

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

Как провести итоговую сверку перед передачей

Финальная проверка должна проследить путь каждого документа от его назначения до конкретного файла. Удобно последовательно пройти по передаваемому составу и для каждой позиции подтвердить несколько связей:

1. Назначение. Понятно, какой документ, раздел или результат изысканий представляет файл и зачем он включен в комплект.
2. Формат. Для данного вида документа выбран формат, соответствующий применимым требованиям; при наличии применимой действующей XML-схемы учтена необходимость XML.
3. Версия. Можно однозначно установить актуальную редакцию и отличить ее от замененных вариантов.
4. Структура. Место файла в комплекте согласуется с перечнем передаваемых документов и позволяет быстро установить связь с другими материалами.
5. Используемость. Документ открывается, читается и может быть рассмотрен в той форме, в которой он передан.
6. Содержание. Отдельно проверено, что техническая корректность файла не используется как подтверждение правильности содержащегося в нем решения.

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

Какой результат должна дать подготовка электронного комплекта

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

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

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