Praktische gidsen

Publiceer begrijpelijke, gedocumenteerde open data

Downloadbare gegevens zijn nog geen begrijpelijke gegevens. Een hergebruiker moet weten wie het heeft geproduceerd, wat het dekt, wat het uitsluit en hoe de velden moeten worden geïnterpreteerd.

Zie de methode

Illustratie — Publiceer begrijpelijke, gedocumenteerde open data
AI-gegenereerde illustratie

Herkomst en reikwijdte vaststellen

Beschrijf producent, verzamelmethode, tijdsperiode en geografische of thematische dekking. Onderscheid extractie, update en meetdata. Een bestand dat vandaag is gepubliceerd, kan een eerdere meting beschrijven; Publicatie verandert niets aan het referentiejaar.

Geef ontbrekende gebieden en geschatte waarden aan waar de bron ze identificeert. Vul een leemte niet met een onbekende schatting. Data.gouv.fr's documentatierichtlijnen behandelt de productiecontext, structuur en mogelijke inconsistenties.

Geef een woordenboek en een voorbeeld

Leg elk veld, een eenheid, type, ontbrekende waarde en referentiecode uit. Geef een klein leesbaar voorbeeld dat consistent is met de volledige dataset. Waar identifiers samenvoegen tabellen, documentrelaties en mogelijk ongeëvenaarde rijen.

onderscheidt entiteiten van hun labels. Een gemeente kan meerdere postcodes en een product meerdere varianten hebben. Documentatie zou misleidende aggregatie of deduplicatie moeten helpen voorkomen die een nuttige relatie verwijdert.

Documenteer bij geodata referentiestelsel en coördinatenvolgorde, niet alleen het formaat. RFC 7946 definieert GeoJSON met WGS 84 en decimale graden; de eerste twee positiewaarden zijn lengtegraad en breedtegraad. In een fictieve oefening mag Point [2.35,48.86] niet [48.86,2.35] worden. Beide arrays zijn leesbaar JSON en de waarden blijven aannemelijk: alleen syntaxcontrole ontdekt deze omwisseling niet.

Onderscheid een niet-gelokaliseerd object van een bekend punt. Een niet-gelokaliseerde GeoJSON Feature mag geometry: null bevatten; dat is geen Point met null-coördinaten en geen vervanging van onbekende data door de echte positie [0,0]. Beschrijf ook wat het punt voorstelt: waargenomen ingang, geocodeerd adres of berekend midden, met herkomst en datum. Meer decimalen maken een schatting niet zekerder.

Schuif de tabel horizontaal om alle kolommen te lezen. Zet met het toetsenbord de focus op de tabel en gebruik de pijltjestoetsen.

Fictieve oefening: betekenis naast leesbaar JSON controleren
GevalBetekenisNuttige controle
Point · coordinates: [2.35,48.86]Lengtegraad 2.35; breedtegraad 48.86Vergelijken met benoemde bronvelden
Point · coordinates: [48.86,2.35]Aannemelijke getallen, verwisseld in deze oefeningBetekenis controleren; syntax volstaat niet
Feature · geometry: nullNiet-gelokaliseerd object; structuurfragmentOntbrekende waarde documenteren zonder punt te verzinnen
Positie [0,0]Bestaande coördinaten, geen afwezigheidNiet automatisch gebruiken voor onbekende waarden

Bekijk publicatie en hergebruik

Identificeer bronhergebruiksvoorwaarden en attributie-informatie die moet worden behouden. Laat de juiste reviewers de publicatierechten en mogelijke persoonsgegevens beoordelen voordat ze openbaar worden vrijgegeven. Een elders zichtbaar adres maakt niet automatisch elke kopie geschikt voor publicatie.

Test downloads zonder interne tools of speciale accounts wanneer openbare toegang wordt beloofd. Controleer formaat, codering en integriteit. Geef een versiereferentie of checksum zodat feedback kan worden gekoppeld aan het gedownloade bestand.

Versies en correcties onderhouden

Kies een realistische beoordelingsfrequentie en een contactpersoon voor problemen. Beschrijf toegevoegde, verwijderde of herdefinieerde velden wanneer schema's veranderen. Onderscheid correcties van nieuwe metingen om te voorkomen dat u valse veranderingen in een tijdreeks maakt.

Bewaar nuttige versies en notities met een duidelijk vervangingsbeleid. Publicatiedocumentatie moet een andere persoon extractie laten reproduceren of de beperkingen ervan begrijpen. Een downloadteller vervangt geen documentatiekwaliteit.

Primaire documentatie: data.gouv.fr : Bien documenter un jeu de données.

Onderscheid de dataset van zijn distributies. Een CSV- en JSON-bestand kunnen dezelfde dataset in twee formaten weergeven; tel ze niet automatisch als twee onafhankelijke metingen. DCAT omschrijft een distributie als een specifieke representatie van een dataset. Vergelijk wel dekking, precisie, velden en versie: twee distributies zijn niet noodzakelijk zonder informatieverlies gelijkwaardig.

Voeg een versieaanduiding en wijzigingsgeschiedenis toe. Een adres voor de ‘nieuwste versie’ kan stabiel blijven, maar de gebruikte versie moet identificeerbaar zijn. Onderscheid ook correctie en nieuwe waarneming: een nieuwe maand meten corrigeert niet vanzelf de vorige. Leg dit verband tussen versies en reeksen uit voordat u cijfers vergelijkt.

Schuif de tabel horizontaal om alle kolommen te lezen. Zet met het toetsenbord de focus op de tabel en gebruik de pijltjestoetsen.

Datapublicatie: object, formaat en revisie identificeren
Documentatie-elementWat het onderscheidtNuttige controle
DatasetHet beschreven onderwerp, bereik en de waarnemingen.De identiteit blijft begrijpelijk ongeacht het bestandsformaat.
CSV- of JSON-distributieEen specifieke representatie van de dataset.Vergelijk velden, precisie en dekking vóór u gelijkwaardigheid aanneemt.
Geïdentificeerde versieEen bepaalde toestand en de wijzigingsgeschiedenis.Vind de aangehaalde versie terug, ook als een actueel adres is bijgewerkt.
Correctie of nieuwe periodeEen herziene waarde of een andere waarneming.Presenteer een nieuwe maand niet als automatische correctie van de vorige.

Referentiedocumenten

Inhoud bijgewerkt

Gedocumenteerde referenties voor dit onderwerp

Gedocumenteerde referenties voor dit onderwerp
ReferentieWaarde of syntaxisToepassingsgebied
RFC 4180 · CSV
text/csv · "a,b"Velden met komma’s, aanhalingstekens of regeleinden krijgen aanhalingstekens; interne tekens worden verdubbeld.
RFC 8259 · JSON
application/json · UTF-8Standaard-JSON staat geen commentaar of afsluitende komma toe; tekenreeksen gebruiken dubbele aanhalingstekens.

De datums geven aan wanneer de bronnen zijn geraadpleegd. Deze gegevens vormen geen site-audit of algemene conformiteitsverklaring.

Functionele validatiematrix om zich aan het project aan te passen

Deze voorgestelde controles gebruiken fictieve gevallen. Bepaal welk gedrag er met het team wordt verwacht, noteer het resultaat en wijs onopgeloste discrepanties toe voor publicatie.

Schuif de tabel horizontaal om alle kolommen te lezen. Zet met het toetsenbord de focus op de tabel en gebruik de pijltjestoetsen.

Testgevallen, verwachte resultaten en nuttig bewijs
GevalVerwacht resultaatBewijs om te houden
Geadverteerde openbare downloadEen externe persoon verkrijgt een leesbaar bestand zonder interne tools.Adres, formaat, grootte en succesvolle opening in een gemeenschappelijke lezer.
Gecontroleerd veld en eenheidHet voorbeeld en het volledige bestand gebruiken dezelfde definitie.Woordenboek, steekproef en vergelijking van bekende waarden over beide representaties.
Onbekende en ongeëvenaarde identificatieBeperkingen blijven zichtbaar zonder een plausibele waarde te vervangen.Beïnvloede rijen en gedocumenteerde regels voor het weergeven van onbekende of ongeëvenaarde informatie.
gepubliceerde correctieEen hergebruiker kan een correctie van een nieuwe meting onderscheiden.Versie, wijzigingsbeschrijving en referentiedatums die bij het gepubliceerde bestand worden bewaard.

Veel gestelde vragen

Welke datum moet een dossier vergezellen?

Toon waar relevant extractie, laatste wijziging en gedekte periode als afzonderlijk genoemde datums. Presenteer niet automatisch de downloadtijd als het referentiejaar van een populatie of een andere meting.

Maakt een licentie alleen gegevens bruikbaar?

Het definieert hergebruiksvoorwaarden, maar velden, eenheden, identificatiegegevens, dekking, kwaliteit en versies hebben ook uitleg nodig. Een andere persoon moet het gebruik kunnen reproduceren of op zijn minst begrijpen.