Как записать авторское пояснение источника в словарь полей без смешения с колонками файла
Практический порядок записи авторских пояснений источника в словарь полей: где хранить определение, как связать его с колонкой без смешения категорий и как проверить, что пользовательское ожидание не записано как свойство файла.
Задача и исходные данные
Перед вами стоит конкретная ситуация: в обменном файле есть колонка с именем, которое в документации источника поясняется авторским термином, и этот термин нужно записать в словарь полей так, чтобы он не смешался с колонками самого файла и не выдавался за поле формата. Для работы понадобятся три вещи: текст спецификации обменного формата, список полей, которые вы ведёте для своей системы, и список авторских терминов источника с их областями употребления. Если источник не публикует формальной спецификации терминов, это нужно сразу пометить в записи.
Определение авторского термина
Авторский термин фиксируется отдельной записью, а не вписывается в описание колонки обменного файла. В записи указываются: само слово, область употребления (какой раздел документации, какой контекст источника), краткое определение в формулировке автора и явная пометка, что это термин модели источника, а не поле формата. Например, запись может выглядеть так: «Термин источника: «баланс клиента». Область: раздел о кошельках. Не является полем CSV или XML обменного файла.» Такая пометка защищает от случайного переноса термина в заголовок колонки при генерации шаблонов.
Связь термина с колонкой
Связь устанавливается ссылкой, а не переносом названия. В описании колонки обменного файла указывается: «Колонка соответствует авторскому термину «баланс клиента» (см. словарь терминов, запись №...)». В самой записи термина указывается обратная ссылка на колонку и на раздел спецификации, где колонка определена. Имя колонки в CSV или XML остаётся тем, что требует формат; авторский термин живёт в словаре и не попадает в заголовки файлов. Если спецификация формата не содержит такого имени, переносить его в заголовок не следует.
Проверка пересечений
Пересечения обнаруживаются простым сопоставлением списков. Составьте два набора имён: поля обменного файла и термины авторской модели. Если одно и то же слово встречается в обоих списках, это не значит, что понятия совпадают. Проверьте область употребления: поле формата имеет тип, допустимые значения и позицию в структуре файла; авторский термин имеет контекст документации и может относиться к объекту, которому в файле соответствует несколько колонок или ни одной. Отметьте совпадение как потенциальное и зафиксируйте решение: либо термины действительно одно и то же и нужна ссылка, либо это разные понятия и в словаре это нужно развести.
Ограничение вывода
Совпадение слов не доказывает взаимозаменяемость понятий. Термин источника может описывать сущность, которая в обменном файле раскладывается на несколько колонок, или наоборот: одна колонка может соответствовать нескольким авторским терминам в разных разделах документации. Запись в словарь полей фиксирует, что вы проверили это и приняли решение, но не утверждает, что формат и модель источника совпадают по построению. Если источник не публикует формального соответствия, это ограничение остаётся открытым и должно быть помечено в записи как отсутствие подтверждения.