Skillnad mellan versioner av "Dokumentation"
Från DAU-handboken
| Rad 1: | Rad 1: | ||
== | == Varför behövs dokumentation? == | ||
För | För att en sekundäranvändare ska kunna avgöra om data är intressanta eller ej är det viktigt att det finns tillräckligt med tillhörande dokumentation. Det är upp till dig som DAU att bedöma om data har den dokumentation som behövs. Det är svårt att exakt säga vad som är tillräckligt eftersom det varierar bl.a. beroende på det specifika forskningsprojektet, vilket ämnesområde det gäller och typ av data. Dokumentation kan t.ex. vara i form av en kortare sammanfattning/abstract, men också som bifogade forskningsrapporter, artiklar och metodbeskrivningar. | ||
I många fall används ''dokumentation'' och ''metadata'' som synonyma begrepp. Gränserna mellan dem kan ibland vara flytade, men det finns skillnader. Dokumentationen riktas i första hand till människor och kan bestå av löpande text, medan metadata är ordnade för att också kunna läsas av datorer. Eftersom dokumentationen inte behöver vara maskinläsbar har den inte samma krav på struktur som metadata. | I många fall används ''dokumentation'' och ''metadata'' som synonyma begrepp. Gränserna mellan dem kan ibland vara flytade, men det finns skillnader. Dokumentationen riktas i första hand till människor och kan bestå av löpande text, medan metadata är ordnade för att också kunna läsas av datorer. Eftersom dokumentationen inte behöver vara maskinläsbar har den inte heller samma krav på struktur som metadata. | ||
Några exempel på sådant som bör dokumenteras är: | |||
* frågeställningar och syftet med studien | * frågeställningar och syftet med studien | ||
| Rad 12: | Rad 12: | ||
* en beskrivning av de data som används för analys | * en beskrivning av de data som används för analys | ||
* hur olika filer hänger ihop | * hur olika filer hänger ihop | ||
Versionen från 23 oktober 2018 kl. 09.31
Varför behövs dokumentation?
För att en sekundäranvändare ska kunna avgöra om data är intressanta eller ej är det viktigt att det finns tillräckligt med tillhörande dokumentation. Det är upp till dig som DAU att bedöma om data har den dokumentation som behövs. Det är svårt att exakt säga vad som är tillräckligt eftersom det varierar bl.a. beroende på det specifika forskningsprojektet, vilket ämnesområde det gäller och typ av data. Dokumentation kan t.ex. vara i form av en kortare sammanfattning/abstract, men också som bifogade forskningsrapporter, artiklar och metodbeskrivningar.
I många fall används dokumentation och metadata som synonyma begrepp. Gränserna mellan dem kan ibland vara flytade, men det finns skillnader. Dokumentationen riktas i första hand till människor och kan bestå av löpande text, medan metadata är ordnade för att också kunna läsas av datorer. Eftersom dokumentationen inte behöver vara maskinläsbar har den inte heller samma krav på struktur som metadata.
Några exempel på sådant som bör dokumenteras är:
- frågeställningar och syftet med studien
- en beskrivning av vald insamlingsmetod
- en överblick över analysarbetet
- en beskrivning av de data som används för analys
- hur olika filer hänger ihop