Estandards.RUСправочник стандарта файла с курсами электронных валют

Модели и форматы обмена

Сверка авторской модели обмена с реальным форматом файла

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

Редакция ·

Схема сверки: слева список авторских терминов, справа список колонок файла, между ними стрелки с тремя исходами сопоставления.

Что входит в авторскую модель источника

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

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

Список колонок обменного файла

Второй шаг состоит в том, чтобы составить перечень колонок обменного файла ровно так, как их отдаёт источник. Для CSV это имена из заголовочной строки, для XML это имена элементов или атрибутов, для TXT это позиции, зафиксированные в спецификации формата. Имена записываются дословно, без транслитерации, без приведения к единому регистру и без замены на более понятные синонимы.

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

Сопоставление двух списков

Третий шаг сопоставляет авторские термины и колонки файла. Совпадение или близость слов не доказывает взаимозаменяемость понятий: авторское «курс обмена» может соответствовать колонке с именем, которое описывает цену в иной системе отсчёта, а авторское «комиссия» может не иметь прямого аналога в файле вовсе.

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

Словарь полей и раздел авторских терминов

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

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