Datu dokumentēšana

Digitālie dati ir mašīnlasāmi. Tomēr datu interpretēšanas uzdevums turpina būt cilvēku uzdevums. Lai paveiktu šo uzdevumu, ir nepieciešama pietiekama kontekstuāla informācija. Datu dokumentēšanas būtiskums datu vākšanas un analītiskajā stadijā nevar tikt novērtēts par zemu.

Kamēr notiek aktīvs datu vākšanas process, ir viegli atcerēties datu klasificēšanas sistēmas nianses, taču diskutabli, kā tas izdosies vēlāk, pēc vairākiem mēnešiem vai ilgāk. Pietiekama dokumentācija, kas skaidro izmantoto klasifikāciju un kodus, mazinās kļūdīšanos nākotnē.

Citiem šie radītie dati var būt interesanti dažādu iemeslu dēļ, piemēram, lai izprastu pētījuma rezultātus (findings), pārbaudītu pētījuma rezultātus, recenzētu publikāciju, replicētu pētījuma rezultātus, veidotu līdzīgu pētījumu, arhivētu datus piekļuvei un atkārtotai izmantošanai.

Dokumentēšanas labā prakse nodrošina to, ka visas augstāk minētās vajadzības ir iespējams realizēt, neskatoties uz to, kāda sistēma vai programmatūra tiek/tiks izmantota.

Datu dokumentēšana ir realizējama, sākot ar pētījuma projekta pirmsākumiem. Vēlāk informāciju ieteicams papildināt, piemēram, projekta progresa fiksēšanas brīžos. Ir nepieciešams iekļaut dokumentēšanas procedūru pētījuma datu pārvaldības plānā. Dokumentēšana datiem var tikt veikta dažādos informācijas un datu līmenī/slāņos:

• Dokumentēšana dažādos datu slāņos/līmenī

Šāda dokumentēšana var tikt iekļauta datos vai pašā dokumentā datnes galvenes vai speciāli nodalītā zonā. Šim līmenim kā piemērus var minēt  birkas jeb tagus, kodus un/vai kodu grāmatas, klasifikācijas, iztrūkstošās vērtības datos, atvasinājumus un agregācijas.

• Dokumentēšana datņu struktūras un datubāzes slānī/līmenī

Šis dokumentēšanas veids sniedz skaidrojumu, kā datu kopā iekļautās datnes ir saistītas savā starpā, kādos datņu formātos tās ir, kuras datnes aizstāj citas, datņu versijas, utt. Datnes readme.txt izveidošana un pievienošana ir ierasts visu projekta datņu un mapju uzskaites veids.

• Dokumentēšana projekta kopējās dokumentācijas slānī/līmenī

Šajā līmenī/slānī sagatavotā dokumentācija skaidro pētījuma mērķus, pētījumā izvirzītos pētījuma jautājumus un hipotēzes, kādas metodoloģijas tiek izmantotas, kādi rīki un mērīšanas instrumenti tiek izmantoti utt. Šo informāciju ietver atsevišķās datnēs, pievienojot datu kopai, tādējādi sniedzot kontekstu, skaidrojumu vai instrukcijas datu izmantošanai un atkārtotai izmantošanai. Šādas dokumentēšanas piemēri iekļauj darba dokumentus, laboratorijas piezīmes, aptauju anketas, intervijas jautājumu struktūras, projekta atskaites dokumentus un publikācijas.

• Dokumentēšana metadatu slānī/līmenī (skat. sadaļā “Kas ir metadati?”)