Примерное время чтения : 5 min · Опубликовано
Установить происхождение и объем
Опишите производителя, метод сбора, период времени и географический или тематический охват. Различают даты извлечения, обновления и измерений. Файл, опубликованный сегодня, может описывать более раннее измерение; Публикация не меняет своего эталонного года.
Укажите отсутствующие области и приблизительные значения, где источник их идентифицирует. Не заполняйте пробел нераскрытой оценкой. Руководство по документации 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], обозначающая реальную позицию. Укажите также смысл точки: обследованный вход, геокодированный адрес или вычисленный центр, с происхождением и датой. Добавление десятичных знаков не делает оценку достовернее.
Прокрутите таблицу по горизонтали, чтобы прочитать все столбцы. При работе с клавиатурой переведите фокус на таблицу и используйте клавиши со стрелками.
| Случай | Значение | Полезная проверка |
|---|---|---|
| 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 | Конкретную форму представления набора. | Сравнить поля, точность и охват до предположения об эквивалентности. |
| Определённая версия | Конкретное состояние и историю изменений. | Найти цитируемую версию, даже если текущий адрес обновлён. |
| Исправление или новый период | Пересмотренное значение или иное наблюдение. | Не выдавать новый месяц за автоматическое исправление предыдущего. |
- W3C DCAT 3 : Представления наборов
Проверено 22 октября 2026 года; наборы, их представления и возможные различия в полноте информации.
- W3C : Данные в Интернете и версии
Проверено 22 октября 2026 года; идентификаторы версий, история и наблюдения за разные периоды.
Справочные документы
- W3C : данные в Интернете · Источник просмотрен
- IETF : GeoJSON RFC 7946 · Источник просмотрен
- data.gouv.fr : Bien documenter un jeu de données
Содержание обновлено
Документированные ориентиры по теме
| Источник | Значение или синтаксис | Область применения |
|---|---|---|
| RFC 4180 · CSV | text/csv · "a,b" | Поля с запятыми, кавычками или переносами заключаются в кавычки; внутренние кавычки удваиваются. |
| RFC 8259 · JSON | application/json · UTF-8 | Стандартный JSON не допускает комментариев и завершающей запятой; строки заключаются в двойные кавычки. |
Даты обозначают обращение к источникам. Эти сведения не являются аудитом сайта или общим заявлением о соответствии.
