Поиск
Введите не менее двух символов без личных данных.

    БиблиотекаСтатьи и часто задаваемые вопросы Ваш проектЗапросить цитату
    ЯзыкRU ▾
    Практические руководства

    публиковать понятные, задокументированные открытые данные

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

    См. метод

    Иллюстрация — публиковать понятные, задокументированные открытые данные
    Иллюстрация, созданная ИИ

    Установить происхождение и объем

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

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

    Предоставьте словарь и пример

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

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

    Для геоданных документируйте систему отсчёта и порядок координат, а не только формат. RFC 7946 определяет GeoJSON с WGS 84 и десятичными градусами; первые два значения позиции — долгота и широта. В вымышленном примере Point [2.35,48.86] не должен стать [48.86,2.35]. Оба массива читаются как JSON, а числа остаются правдоподобными: одна проверка синтаксиса перестановку не выявит.

    Отличайте объект без определённого местоположения от известной точки. У такой GeoJSON Feature значение geometry может быть null; это не Point с пустыми координатами и не подстановка [0,0], обозначающая реальную позицию. Укажите также смысл точки: обследованный вход, геокодированный адрес или вычисленный центр, с происхождением и датой. Добавление десятичных знаков не делает оценку достовернее.

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

    Вымышленное упражнение: проверить смысл сверх читаемости JSON
    СлучайЗначениеПолезная проверка
    Point · coordinates: [2.35,48.86]Долгота 2.35; широта 48.86Сравнить с именованными полями источника
    Point · coordinates: [48.86,2.35]Правдоподобные числа, в примере переставленыПроверить смысл; синтаксиса недостаточно
    Feature · geometry: nullОбъект без местоположения; фрагмент структурыДокументировать отсутствие, не выдумывать точку
    Позиция [0,0]Существующие координаты, не отсутствиеНе подставлять автоматически вместо неизвестного

    Проверить публикацию и повторное использование

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

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

    Поддерживайте версии и исправления

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

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

    Первичная документация: data.gouv.fr : Bien documenter un jeu de données.

    Различайте набор данных и его представления. CSV и JSON могут передавать один набор в двух форматах; не считайте их автоматически независимыми измерениями. DCAT описывает дистрибутив как конкретное представление набора. Однако сравните охват, точность, поля и версию: два представления не обязательно эквивалентны без потери информации.

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

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

    Публикация данных: определить объект, формат и редакцию
    Элемент документацииЧто он различаетПолезная проверка
    Набор данныхОписываемые тему, охват и наблюдения.Сущность набора понятна независимо от формата файла.
    Представление CSV или JSONКонкретную форму представления набора.Сравнить поля, точность и охват до предположения об эквивалентности.
    Определённая версияКонкретное состояние и историю изменений.Найти цитируемую версию, даже если текущий адрес обновлён.
    Исправление или новый периодПересмотренное значение или иное наблюдение.Не выдавать новый месяц за автоматическое исправление предыдущего.

    Справочные документы

    Содержание обновлено

    Документированные ориентиры по теме

    Документированные ориентиры по теме
    ИсточникЗначение или синтаксисОбласть применения
    RFC 4180 · CSV
    text/csv · "a,b"Поля с запятыми, кавычками или переносами заключаются в кавычки; внутренние кавычки удваиваются.
    RFC 8259 · JSON
    application/json · UTF-8Стандартный JSON не допускает комментариев и завершающей запятой; строки заключаются в двойные кавычки.

    Даты обозначают обращение к источникам. Эти сведения не являются аудитом сайта или общим заявлением о соответствии.

    Матрица функциональной проверки для адаптации к проекту

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

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

    Тестовые случаи, ожидаемые результаты и полезные доказательства
    КейсОжидаемый результатДоказательство для сохранения
    Рекламируемая общедоступная загрузкаВнешнее лицо получает читаемый файл без внутренних инструментов.Адрес, формат, размер и успешное открытие в общем читателе.
    Проверенное поле и единица измеренияВ примере и полном файле используется то же определение.Словарь, образец и сравнение известных значений для обоих представлений.
    Неизвестный и непревзойденный идентификаторОграничения остаются видимыми без замены правдоподобного значения.Затронутые строки и документированные правила для представления неизвестной или несравненной информации.
    Опубликовано исправлениеПовторный пользователь может отличить поправку от нового измерения.Версия, изменение описания и даты ссылки, сохраненные в опубликованном файле.

    Часто задаваемые вопросы

    Какая дата должна сопровождать файл?

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

    Только лицензия делает данные пригодными для использования?

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