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