Arvioitu lukuaika : 4 min · Julkaistu
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ä.
| Tapaus | Tulkinta | Hyödyllinen tarkistus |
|---|---|---|
| Point · coordinates: [2.35,48.86] | Pituusaste 2.35; leveysaste 48.86 | Vertaa nimettyihin lähdekenttiin |
| Point · coordinates: [48.86,2.35] | Uskottavat luvut, harjoituksessa väärä järjestys | Tarkista merkitys; syntaksi ei riitä |
| Feature · geometry: null | Paikantamaton kohde; rakennekatkelma | Dokumentoi 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ä.
| Dokumentointitieto | Mitä se erottaa | Hyödyllinen tarkistus |
|---|---|---|
| Tietoaineisto | Kuvatun aiheen, rajauksen ja havainnot. | Aineiston identiteetti ymmärretään tiedostomuodosta riippumatta. |
| CSV- tai JSON-jakelu | Aineiston tietyn esitysmuodon. | Vertaa kenttiä, tarkkuutta ja kattavuutta ennen vastaavuuden olettamista. |
| Tunnistettu versio | Tietyn tilan ja muutoshistorian. | Löydä viitattu versio, vaikka nykyosoitteen sisältö olisi päivitetty. |
| Korjaus tai uusi ajanjakso | Tarkistetun arvon tai eri havainnon. | Älä esitä uutta kuukautta edellisen automaattisena korjauksena. |
- W3C DCAT 3 : Jakelut
Tarkistettu 22. lokakuuta 2026; aineistot, esitysmuodot ja mahdolliset tiedolliset erot.
- W3C : Verkon tiedot ja versiot
Tarkistettu 22. lokakuuta 2026; versiotunnisteet, historia ja eri ajanjaksojen havainnot.
viiteasiakirjat
- W3C : Tiedot verkon parhaista käytännöistä · Lähde tarkistettu
- IETF : GeoJSON RFC 7946 · Lähde tarkistettu
- data.gouv.fr : Bien documenter un jeu de données
Sisältö päivitetty
Aiheen dokumentoidut viitekohdat
| Viite | Arvo tai syntaksi | Soveltamisala |
|---|---|---|
| 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-8 | Tavallinen 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.
