käytännön oppaat

Julkaise ymmärrettävää, dokumentoitua avointa dataa

Ladattavat tiedot eivät ole vielä ymmärrettäviä tietoja. Uudelleenkäyttäjän on tiedettävä, kuka sen on tuottanut, mitä se kattaa, mitä se sulkee pois ja miten sen kenttiä tulkitaan.

Katso menetelmä

Kuvitus — Julkaise ymmärrettävää, dokumentoitua avointa dataa
Tekoälyllä luotu kuvitus

vahvistaa alkuperää ja laajuutta

Kuvaa tuottaja, keräysmenetelmä, ajanjakso ja maantieteellinen tai temaattinen kattavuus. Erottele erotus-, päivitys- ja mittauspäivämäärät. Tänään julkaistu tiedosto saattaa kuvata aikaisempaa mittausta; Julkaisu ei muuta viitevuotta.

Ilmoita puuttuvat alueet ja likimääräiset arvot, joissa lähde tunnistaa ne. Älä täytä aukkoa julkistamattomalla arviolla. Data.gouv.fr:n dokumentaatioohjeissa käsitellään tuotantokontekstia, rakennetta ja mahdollisia epäjohdonmukaisuuksia.

antaa sanakirjan ja esimerkin

Selitä jokainen kenttä, yksikkö, tyyppi, puuttuva arvo ja viitekoodi. Anna pieni luettava esimerkki, joka on yhdenmukainen koko tietojoukon kanssa. jossa tunnisteet yhdistävät taulukoita, asiakirjasuhteita ja mahdollisesti vertaansa vailla olevia rivejä.

erottaa entiteetit etiketeistään. Kunnalla voi olla useita postinumeroita ja tuote useita muunnelmia. Dokumentaation pitäisi auttaa estämään harhaanjohtava aggregointi tai duplikaatio, joka poistaa hyödyllisen suhteen.

Dokumentoi paikkatiedoissa viitejärjestelmä ja koordinaattijärjestys, älä vain muodon nimeä. RFC 7946 määrittää GeoJSONin WGS 84:n desimaaliasteina; sijainnin kaksi ensimmäistä arvoa ovat pituusaste ja leveysaste. Kuvitteellisen harjoituksen Point [2.35,48.86] ei saa muuttua muotoon [48.86,2.35]. Molemmat taulukot ovat luettavaa JSONia ja luvut uskottavia: pelkkä syntaksitarkistus ei havaitse vaihtoa.

Erota paikantamaton kohde tunnetusta pisteestä. Paikantamattoman GeoJSON Feature -kohteen geometry voi olla null; se ei ole Point tyhjillä koordinaateilla eikä tuntemattoman korvaamista todellisella sijainnilla [0,0]. Kuvaa myös pisteen tarkoitus: havaittu sisäänkäynti, geokoodattu osoite tai laskettu keskipiste, alkuperineen ja päivämäärineen. Desimaalien lisääminen ei tee arviosta varmempaa.

Vieritä taulukkoa vaakasuunnassa nähdäksesi kaikki sarakkeet. Siirrä näppäimistöllä kohdistus taulukkoon ja käytä nuolinäppäimiä.

Kuvitteellinen harjoitus: merkityksen tarkistus luettavan JSONin lisäksi
TapausTulkintaHyödyllinen tarkistus
Point · coordinates: [2.35,48.86]Pituusaste 2.35; leveysaste 48.86Vertaa nimettyihin lähdekenttiin
Point · coordinates: [48.86,2.35]Uskottavat luvut, harjoituksessa väärä järjestysTarkista merkitys; syntaksi ei riitä
Feature · geometry: nullPaikantamaton kohde; rakennekatkelmaDokumentoi puuttuva arvo keksimättä pistettä
Sijainti [0,0]Olemassa olevat koordinaatit, ei puuttuva arvoÄlä korvaa tuntematonta automaattisesti tällä

Tarkista julkaisu ja käytä uudelleen

Tunnista lähteen uudelleenkäyttöehdot ja attribuutiotiedot säilytettäväksi. Pyydä asianmukaisia arvioijia arvioimaan julkaisuoikeudet ja mahdolliset henkilötiedot ennen julkistamista. Muualla näkyvä osoite ei automaattisesti tee jokaisesta kopiosta julkaisuun sopivaa.

Testaa latauksia ilman sisäisiä työkaluja tai erityisiä tilejä, kun julkista pääsyä luvataan. Tarkista muoto, koodaus ja eheys. Anna versioviittaus tai tarkistussumma, jotta palaute voidaan liittää ladattuun tiedostoon.

Ylläpidä versioita ja korjauksia

Valitse realistinen arvostelutiheys ja yhteystieto ongelmien varalta. Kuvaa lisätyt, poistetut tai uudelleenmääritetyt kentät, kun skeemat muuttuvat. Erota korjaukset uusista mittauksista välttääksesi väärien muutosten luomisen aikasarjaan.

Säilytä hyödyllisiä versioita ja muistiinpanoja selkeällä korvauskäytännöllä. Julkaisudokumentaation tulisi antaa toisen henkilön toistaa poiminta tai ymmärtää sen rajoitukset. Latauslaskuri ei korvaa dokumentaation laatua.

ensisijainen dokumentaatio: data.gouv.fr : Bien documenter un jeu de données.

Erota tietoaineisto sen jakeluista. CSV ja JSON voivat esittää saman aineiston kahdessa muodossa; älä laske niitä automaattisesti erillisiksi mittauksiksi. DCAT kuvaa jakelun aineiston tietyksi esitysmuodoksi. Vertaa silti kattavuutta, tarkkuutta, kenttiä ja versiota: kaksi jakelua eivät välttämättä vastaa toisiaan ilman tietohäviötä.

Lisää versiotunniste ja korjaushistoria. Uusimman version osoite voi pysyä samana, mutta todella käytetty versio on voitava tunnistaa. Erota myös korjaus uudesta havainnosta: uuden kuukauden mittaus ei itsessään korjaa edellistä kuukautta. Selitä versioiden ja sarjojen suhde ennen lukujen vertailua.

Vieritä taulukkoa vaakasuunnassa nähdäksesi kaikki sarakkeet. Siirrä näppäimistöllä kohdistus taulukkoon ja käytä nuolinäppäimiä.

Tietojen julkaisu: tunnista kohde, muoto ja revisio
DokumentointitietoMitä se erottaaHyödyllinen tarkistus
TietoaineistoKuvatun aiheen, rajauksen ja havainnot.Aineiston identiteetti ymmärretään tiedostomuodosta riippumatta.
CSV- tai JSON-jakeluAineiston tietyn esitysmuodon.Vertaa kenttiä, tarkkuutta ja kattavuutta ennen vastaavuuden olettamista.
Tunnistettu versioTietyn tilan ja muutoshistorian.Löydä viitattu versio, vaikka nykyosoitteen sisältö olisi päivitetty.
Korjaus tai uusi ajanjaksoTarkistetun arvon tai eri havainnon.Älä esitä uutta kuukautta edellisen automaattisena korjauksena.

Sisältö päivitetty

Aiheen dokumentoidut viitekohdat

Aiheen dokumentoidut viitekohdat
ViiteArvo tai syntaksiSoveltamisala
RFC 4180 · CSV
text/csv · "a,b"Pilkun, lainausmerkin tai rivinvaihdon sisältävät kentät lainataan; sisäiset lainausmerkit kahdennetaan.
RFC 8259 · JSON
application/json · UTF-8Tavallinen JSON ei salli kommentteja tai loppupilkkuja; merkkijonot käyttävät kaksinkertaisia lainausmerkkejä.

Päivämäärät kertovat lähteiden tarkistamisesta. Tiedot eivät ole sivuston auditointi tai yleinen vaatimustenmukaisuusvakuutus.

toiminnallinen validointimatriisi, joka mukautuu projektiin

Nämä ehdotetut kontrollit käyttävät kuvitteellisia tapauksia. Päätä, mitä käyttäytymistä tiimin kanssa odotetaan, kirjoita tulos muistiin ja määritä ratkaisemattomia eroja ennen julkaisemista.

Vieritä taulukkoa vaakasuunnassa nähdäksesi kaikki sarakkeet. Siirrä näppäimistöllä kohdistus taulukkoon ja käytä nuolinäppäimiä.

testitapaukset, odotetut tulokset ja hyödyllisiä todisteita
Asiaodotettu tulostodiste säilyttää
mainostettu julkinen latausUlkopuolinen henkilö saa luettavan tiedoston ilman sisäisiä työkaluja.osoite, muoto, koko ja onnistunut avaus yhteisessä lukijassa.
Tarkistettu kenttä ja yksikköEsimerkki ja koko tiedosto käyttävät samaa määritelmää.Sanakirja, näyte ja tunnettujen arvojen vertailu molemmissa esityksissä.
Tuntematon ja vertaansa vailla oleva tunnisterajoitukset pysyvät näkyvissä ilman, että ne korvaavat uskottavaa arvoa.Vaikuttavat rivit ja dokumentoidut säännöt tuntemattomien tai vertaansa vailla olevien tietojen esittämiseen.
julkaistu korjausUudelleenkäyttäjä voi erottaa korjauksen uudesta mittauksesta.versio, muutoskuvaus ja julkaistun tiedoston viitepäivämäärät.

Usein kysyttyjä kysymyksiä

Minkä päivämäärän tulee olla tiedoston mukana?

Esitä tarvittaessa poiminta, viimeinen muutos ja katettu ajanjakso erikseen nimettyinä päivämäärinä. Älä esitä latausaikaa automaattisesti populaation tai muun mittauksen viitevuotena.

Tekeekö lisenssi pelkästään tiedoista käyttökelpoisia?

Se määrittelee uudelleenkäyttöehdot, mutta myös kentät, yksiköt, tunnisteet, kattavuus, laatu ja versiot tarvitsevat selityksen. toisen henkilön pitäisi pystyä lisääntymään tai ainakin ymmärtämään sen käyttöä.