Guías prácticas

Publicar datos abiertos comprensibles y documentados

Los datos descargables aún no son datos comprensibles. Un reutilizador necesita saber quién lo produjo, qué cubre, qué excluye y cómo interpretar sus campos.

Ver el método

Ilustración — Publicar datos abiertos comprensibles y documentados
Ilustración generada por IA

Establecer procedencia y alcance

Describa el productor, el método de recolección, el período de tiempo y la cobertura geográfica o temática. Distinguir las fechas de extracción, actualización y medición. Un archivo publicado hoy puede describir una medida anterior; La publicación no cambia su año de referencia.

Determine las áreas faltantes y los valores aproximados donde la fuente las identifica. No llene un vacío con una estimación no revelada. La guía de documentación de data.gouv.fr aborda el contexto de producción, la estructura y las posibles inconsistencias.

Proporcione un diccionario y un ejemplo

Explique cada campo, unidad, tipo, valor faltante y código de referencia. Proporcione un pequeño ejemplo legible consistente con el conjunto de datos completo. donde los identificadores se unen a las tablas, las relaciones de los documentos y las filas potencialmente incomparables.

distinguir a las entidades de sus etiquetas. Un municipio puede tener varios códigos postales y un producto varias variantes. La documentación debería ayudar a evitar la agregación o deduplicación engañosa que elimine una relación útil.

En datos geográficos documente el sistema de referencia y el orden, no solo el formato. La RFC 7946 define GeoJSON con WGS 84 y grados decimales; las dos primeras cifras de una posición son longitud y latitud. En un ejercicio ficticio, el Point [2.35,48.86] no debe convertirse en [48.86,2.35]. Ambos arrays son JSON legible y sus valores plausibles: validar solo la sintaxis no detecta la inversión.

Distinga una entidad sin localizar de un punto conocido. En una Feature GeoJSON sin localizar, geometry puede ser null; no equivale a un Point con coordenadas nulas ni a sustituir lo desconocido por [0,0], una posición real. Explique también si el punto es entrada observada, dirección geocodificada o centro calculado, con origen y fecha. Más decimales no hacen más cierta una estimación.

Desplace la tabla horizontalmente para leer todas las columnas. Con el teclado, sitúe el foco en la tabla y use las flechas.

Ejercicio ficticio: comprobar el significado además del JSON legible
CasoInterpretaciónControl útil
Point · coordinates: [2.35,48.86]Longitud 2.35; latitud 48.86Comparar con campos de origen con nombre
Point · coordinates: [48.86,2.35]Cifras plausibles, invertidas en este ejercicioComprobar significado; no basta la sintaxis
Feature · geometry: nullEntidad sin localizar; fragmento de estructuraDocumentar la ausencia sin inventar un punto
Posición [0,0]Coordenadas existentes, no ausenciaNo sustituir automáticamente un valor desconocido

Consultar publicación y reutilización

Identificar las condiciones de reutilización de la fuente y la información de atribución para retener. Haga que los revisores apropiados evalúen los derechos de publicación y los posibles datos personales antes de la publicación pública. Una dirección visible en otro lugar no hace que todas las copias sean adecuadas para su publicación.

Pruebe las descargas sin herramientas internas ni cuentas especiales cuando se promete acceso público. Comprobar formato, codificación e integridad. Proporcione una referencia de versión o una suma de verificación para que los comentarios puedan vincularse al archivo descargado.

Mantener versiones y correcciones

Elija una frecuencia de revisión realista y un contacto para los problemas. Describa los campos agregados, eliminados o redefinidos cuando cambian los esquemas. Distingue las correcciones de las nuevas mediciones para evitar crear cambios falsos en una serie de tiempo.

Conserve versiones y notas útiles con una política de reemplazo clara. La documentación de publicación debe permitir que otra persona reproduzca la extracción o comprenda sus limitaciones. Un contador de descargas no reemplaza la calidad de la documentación.

Documentación principal: data.gouv.fr : Bien documenter un jeu de données.

Distinga el conjunto de datos de sus distribuciones. Un CSV y un JSON pueden representar el mismo conjunto en dos formatos; no los cuente automáticamente como dos mediciones independientes. DCAT describe una distribución como una representación concreta del conjunto. Compare cobertura, precisión, campos y versión: dos distribuciones no son necesariamente equivalentes sin pérdida de información.

Añada un identificador de versión y un historial que explique las correcciones. Una dirección de «última versión» puede mantenerse estable, pero debe poder identificarse la versión utilizada. Distinga también corrección y observación nueva: medir otro mes no corrige por sí mismo el anterior. Explique la relación entre versiones y series antes de comparar cifras.

Desplace la tabla horizontalmente para leer todas las columnas. Con el teclado, sitúe el foco en la tabla y use las flechas.

Publicación de datos: identificar objeto, formato y revisión
Elemento documentalQué distingueComprobación útil
Conjunto de datosTema, ámbito y observaciones descritas.Su identidad se entiende independientemente del formato del archivo.
Distribución CSV o JSONUna representación concreta del conjunto.Comparar campos, precisión y cobertura antes de suponer equivalencia.
Versión identificadaUn estado preciso y su historial de cambios.Recuperar la versión citada aunque se haya actualizado una dirección actual.
Corrección o período nuevoUn valor revisado o una observación distinta.No presentar otro mes como corrección automática del anterior.

Documentos de referencia

Contenido actualizado

Referencias documentadas para este tema

Referencias documentadas para este tema
ReferenciaValor o sintaxisAlcance
RFC 4180 · CSV
text/csv · "a,b"Se entrecomillan campos con comas, comillas o saltos de línea; las comillas internas se duplican.
RFC 8259 · JSON
application/json · UTF-8JSON estándar no admite comentarios ni comas finales; las cadenas usan comillas dobles.

Las fechas indican la consulta de las referencias. Estos datos no constituyen una auditoría ni una declaración global de conformidad.

Matriz de validación funcional para adaptarse al proyecto

Estos controles propuestos utilizan casos ficticios. Decida qué comportamiento se espera con el equipo, anote el resultado y asigne discrepancias no resueltas antes de la publicación.

Desplace la tabla horizontalmente para leer todas las columnas. Con el teclado, sitúe el foco en la tabla y use las flechas.

Casos de prueba, resultados esperados y evidencia útil
CasoResultado esperadoPrueba para mantener
Descarga pública anunciadaUna persona externa obtiene un archivo legible sin herramientas internas.Dirección, formato, tamaño y apertura exitosa en un lector común.
Campo y unidad comprobadosEl ejemplo y el archivo completo usan la misma definición.Diccionario, muestra y comparación de valores conocidos en ambas representaciones.
Identificador desconocido e inigualableLas limitaciones permanecen visibles sin sustituir un valor plausible.Filas afectadas y reglas documentadas para representar información desconocida o incomparable.
Corrección publicadaUn reusador puede distinguir una corrección de una nueva medida.Versión, descripción de cambio y fechas de referencia retenidas con el archivo publicado.

Preguntas frecuentes

¿Qué fecha debe acompañar un archivo?

En su caso, muestre la extracción, la última modificación y el período cubierto como fechas con nombre por separado. No presente automáticamente el tiempo de descarga como el año de referencia de una población u otra medida.

¿Una licencia por sí sola hace que los datos sean utilizables?

Define las condiciones de reutilización, pero los campos, unidades, identificadores, cobertura, calidad y versiones también necesitan explicación. Otra persona debe ser capaz de reproducir o al menos entender el uso.