Övergripande principer för dokumentation. SND Svensk nationell datatjänst

Transkript

1 Övergripande principer för dokumentation SND Svensk nationell tjänst

2 Datarepositorium Söka Återanvända Projektplanera Tillgängliggöra Dataflöde under forskningsprocessen Samla in & organisera Bevara Analysera & publicera resultat SND Svensk nationell tjänst

3 Datarepositorium Söka Återanvända Tillgängliggöra Projektplanera Dataflöde under forskningsprocessen Samla in & organisera Bevara Analysera & publicera resultat SND Svensk nationell tjänst

8 Systematisk dokumentation Att systematiskt dokumentera sitt forskningsmaterial är väsentligt för att senare ska kunna: - publiceras - sökas fram - återanvändas & citeras SND Svensk nationell tjänst

9 Varför dokumentera forskning? Så att forskaren själv vet vad som gjorts (vad betyder var3exam1test?) Så att andra vet vad forskaren gjort, t.ex.: - vid granskning av publikation - för att kunna förstå, verifiera eller replikera resultat - möjliggöra återanvändning Lagkrav Riktlinjer och regler SND Svensk nationell tjänst

10 En väldokumenterad samling innefattar information som syftar till att vara fullständig och självförklarande för framtida användare.

11 Att komma igång med dokumentation Börja tidigt och dokumentera konsekvent genom hela projektet. SND Svensk nationell tjänst

12 Att komma igång med dokumentation Börja tidigt och dokumentera konsekvent genom hela projektet. Fundera på vilken information som behövs för att andra ska förstå och kunna återanvända materialet. SND Svensk nationell tjänst

13 Att komma igång med dokumentation Börja tidigt och dokumentera konsekvent genom hela projektet. Fundera på vilken information som behövs för att andra ska förstå och kunna återanvända materialet. Skapa en separat dokumentationsfil med information om materialet. T.ex. en variabellista för varje set. SND Svensk nationell tjänst

14 Att komma igång med dokumentation Börja tidigt och dokumentera konsekvent genom hela projektet. Fundera på vilken information som behövs för att andra ska förstå och kunna återanvända materialet. Skapa en separat dokumentationsfil med information om materialet. T.ex. en variabellista för varje set. Planera var ska bevaras och tillgängliggöras - be om råd kring dokumentation och meta. SND Svensk nationell tjänst

15 Dokumentation på olika nivåer Projekt-/studienivå (syfte, sammanfattning, urval, insamling etc.) SND Svensk nationell tjänst

16 Dokumentation på olika nivåer Projekt-/studienivå (syfte, sammanfattning, urval, insamling etc.) Fil-/set-/basnivå (filformat, version, organisering etc.) SND Svensk nationell tjänst

17 Dokumentation på olika nivåer Projekt-/studienivå (syfte, sammanfattning, urval, insamling etc.) Fil-/set-/basnivå (filformat, version, organisering etc.) Variabel-/objektnivå (variabelbeskrivning, instrument, frågeformulering etc.) SND Svensk nationell tjänst

18 Exempel på dokumentation under forskningsprocessen SND Svensk nationell tjänst

19 Fas i forskningsprocessen Väsentligt att dokumentera (exempel) 1 Projektplanering Information om det planerade forskningsprojektet såsom frågeställningar, syfte, metodik etc. Plan för hur materialet är tänkt att hanteras och bevaras. Ansvarsområden, beslut, och löpande anteckningar. Stöd för att strukturera dokumentationen (exempel) Forskningsbeskrivning/Forskningsplan/ Forskningsprotokoll, Bevarandeplan Datahanteringsplan () 2 Samla in och organisera 3 Analysera & publicera resultat 4 Bevara och förbereda 5 Tillgängliggöra Löpande anteckningar under projektet t.ex. i samband med insamling av, beslut som fattas, kontakter som tas, etc. Beskrivning av forskningsprojektets, hur har rensats, bearbetats etc. Beskrivning av metoder såsom urvalsmetod, insamlingsmetod, verktyg/instrument etc. Kompletterande beskrivningar om hantering (principer för versionering, mappstruktur, filnamn etc) Överblick av analysarbetet (frågeställningar, medförfattare, variabler, beslut etc.) Beskrivning av variabler i fil som används för analys Beskrivning om hur analyser utförs (i statistikprogram) Överblick av filer och hur de hänger ihop etc. Komplettering/korrigering av aspekter kring hantering Lista över filer och dokumentation som ska arkiveras, olika beslut som fattas inför slutfasen, åtgärder innan tillgängliggörande etc. Beslut och rutiner kring tillgängliggörande, t.ex. information om hur citering ska anges i samband med sekundäranalys av materialet. Fältanteckningar Kodbok/variabellista, statistikfiler Dokumentationsprogram Teknisk rapport/metodbeskrivning Analysplan Kodbok, variabellista Analysloggbok, programkodfiler/syntaxer/loggfil, readme.txt fil, basschema Datahanteringsplan ()

20 Fas i forskningsprocessen Väsentligt att dokumentera (exempel) 1 Projektplanering Information om det planerade forskningsprojektet såsom frågeställningar, syfte, metodik etc. Plan för hur materialet är tänkt att hanteras och bevaras. Ansvarsområden, beslut, och löpande anteckningar. Stöd för att strukturera dokumentationen (exempel) Forskningsbeskrivning/Forskningsplan/ Forskningsprotokoll, Bevarandeplan Datahanteringsplan () 2 Samla in och organisera 3 Analysera & publicera resultat 4 Bevara och förbereda 5 Tillgängliggöra Löpande anteckningar under projektet t.ex. i samband med insamling av, beslut som fattas, kontakter som tas, etc. Beskrivning av forskningsprojektets, hur har rensats, bearbetats etc. Beskrivning av metoder såsom urvalsmetod, insamlingsmetod, verktyg/instrument etc. Kompletterande beskrivningar om hantering (principer för versionering, mappstruktur, filnamn etc) Överblick av analysarbetet (frågeställningar, medförfattare, variabler, beslut etc.) Beskrivning av variabler i fil som används för analys Beskrivning om hur analyser utförs (i statistikprogram) Överblick av filer och hur de hänger ihop etc. Komplettering/korrigering av aspekter kring hantering Lista över filer och dokumentation som ska arkiveras, olika beslut som fattas inför slutfasen, åtgärder innan tillgängliggörande etc. Beslut och rutiner kring tillgängliggörande, t.ex. information om hur citering ska anges i samband med sekundäranalys av materialet. Fältanteckningar Kodbok/variabellista, statistikfiler Dokumentationsprogram Teknisk rapport/metodbeskrivning Analysplan Kodbok, variabellista Analysloggbok, programkodfiler/syntaxer/loggfil, readme.txt fil, basschema Datahanteringsplan ()

21 Fas i forskningsprocessen Väsentligt att dokumentera (exempel) 1 Projektplanering Information om det planerade forskningsprojektet såsom frågeställningar, syfte, metodik etc. Plan för hur materialet är tänkt att hanteras och bevaras. Ansvarsområden, beslut, och löpande anteckningar. Stöd för att strukturera dokumentationen (exempel) Forskningsbeskrivning/Forskningsplan/ Forskningsprotokoll Datahanteringsplan () 2 Samla in och organisera 3 Analysera & publicera resultat 4 Bevara och förbereda 5 Tillgängliggöra Löpande anteckningar under projektet t.ex. i samband med insamling av, beslut som fattas, kontakter som tas, etc. Beskrivning av forskningsprojektets, hur har rensats, bearbetats etc. Beskrivning av metoder såsom urvalsmetod, insamlingsmetod, verktyg/instrument etc. Kompletterande beskrivningar om hantering (principer för versionering, mappstruktur, filnamn etc) Överblick av analysarbetet (frågeställningar, medförfattare, variabler, beslut etc.) Beskrivning av variabler i fil som används för analys Beskrivning om hur analyser utförs (i statistikprogram) Överblick av filer och hur de hänger ihop etc. Komplettering/korrigering av aspekter kring hantering Lista över filer och dokumentation som ska arkiveras, olika beslut som fattas inför slutfasen, åtgärder innan tillgängliggörande etc. Beslut och rutiner kring tillgängliggörande, t.ex. information om hur citering ska anges i samband med sekundäranalys av materialet. Fältanteckningar Kodbok/variabellista, statistikfiler Dokumentationsprogram Teknisk rapport/metodbeskrivning Analysplan Kodbok, variabellista Analysloggbok, programkodfiler/syntaxer/loggfil, readme.txt fil, basschema Datahanteringsplan ()

22 Fas i forskningsprocessen Väsentligt att dokumentera (exempel) 1 Projektplanering Information om det planerade forskningsprojektet såsom frågeställningar, syfte, metodik etc. Plan för hur materialet är tänkt att hanteras och bevaras. Ansvarsområden, beslut, och löpande anteckningar. Stöd för att strukturera dokumentationen (exempel) Forskningsbeskrivning/Forskningsplan/ Forskningsprotokoll Datahanteringsplan () 2 Samla in och organisera 3 Analysera & publicera resultat 4 Bevara och förbereda 5 Tillgängliggöra Löpande anteckningar under projektet t.ex. i samband med insamling av, beslut som fattas, kontakter som tas, etc. Beskrivning av forskningsprojektets, hur har rensats, bearbetats etc. Beskrivning av metoder såsom urvalsmetod, insamlingsmetod, verktyg/instrument etc. Kompletterande beskrivningar om hantering (principer för versionering, mappstruktur, filnamn etc) Överblick av analysarbetet (frågeställningar, medförfattare, variabler, beslut etc.) Beskrivning av variabler i fil som används för analys Beskrivning om hur analyser utförs (i statistikprogram) Överblick av filer och hur de hänger ihop etc. Komplettering/korrigering av aspekter kring hantering Lista över filer och dokumentation som ska arkiveras, olika beslut som fattas inför slutfasen, åtgärder innan tillgängliggörande etc. Beslut och rutiner kring tillgängliggörande, t.ex. information om hur citering ska anges i samband med sekundäranalys av materialet. Fältanteckningar Kodbok/variabellista, statistikfiler Dokumentationsprogram Teknisk rapport/metodbeskrivning Analysplan Kodbok, variabellista Analysloggbok, programkodfiler/syntaxer/loggfil, readme.txt fil, basschema Datahanteringsplan ()

23 Fas i forskningsprocessen Väsentligt att dokumentera (exempel) 1 Projektplanering Information om det planerade forskningsprojektet såsom frågeställningar, syfte, metodik etc. Plan för hur materialet är tänkt att hanteras och bevaras. Ansvarsområden, beslut, och löpande anteckningar. Stöd för att strukturera dokumentationen (exempel) Forskningsbeskrivning/Forskningsplan/ Forskningsprotokoll Datahanteringsplan () 2 Samla in och organisera 3 Analysera & publicera resultat 4 Bevara och förbereda 5 Tillgängliggöra Löpande anteckningar under projektet t.ex. i samband med insamling av, beslut som fattas, kontakter som tas, etc. Beskrivning av forskningsprojektets, hur har rensats, bearbetats etc. Beskrivning av metoder såsom urvalsmetod, insamlingsmetod, verktyg/instrument etc. Kompletterande beskrivningar om hantering (principer för versionering, mappstruktur, filnamn etc) Överblick av analysarbetet (frågeställningar, medförfattare, variabler, beslut etc.) Beskrivning av variabler i fil som används för analys Beskrivning om hur analyser utförs (i statistikprogram) Överblick av filer och hur de hänger ihop etc. Komplettering/korrigering av aspekter kring hantering Lista över filer och dokumentation som ska bevaras, olika beslut som fattas inför slutfasen, åtgärder innan tillgängliggörande etc. Beslut och rutiner kring tillgängliggörande, t.ex. information om hur citering ska anges i samband med sekundäranalys av materialet. Fältanteckningar Kodbok/variabellista, statistikfiler Dokumentationsprogram Teknisk rapport/metodbeskrivning Analysplan Kodbok, variabellista Analysloggbok, programkodfiler/syntaxer/loggfil, readme.txt fil, basschema Datahanteringsplan ()

24 Fas i forskningsprocessen Väsentligt att dokumentera (exempel) 1 Projektplanering Information om det planerade forskningsprojektet såsom frågeställningar, syfte, metodik etc. Plan för hur materialet är tänkt att hanteras och bevaras. Ansvarsområden, beslut, och löpande anteckningar. Stöd för att strukturera dokumentationen (exempel) Forskningsbeskrivning/Forskningsplan/ Forskningsprotokoll Datahanteringsplan () 2 Samla in och organisera 3 Analysera & publicera resultat 4 Bevara och förbereda 5 Tillgängliggöra Löpande anteckningar under projektet t.ex. i samband med insamling av, beslut som fattas, kontakter som tas, etc. Beskrivning av forskningsprojektets, hur har rensats, bearbetats etc. Beskrivning av metoder såsom urvalsmetod, insamlingsmetod, verktyg/instrument etc. Kompletterande beskrivningar om hantering (principer för versionering, mappstruktur, filnamn etc) Överblick av analysarbetet (frågeställningar, medförfattare, variabler, beslut etc.) Beskrivning av variabler i fil som används för analys Beskrivning om hur analyser utförs (i statistikprogram) Överblick av filer och hur de hänger ihop etc. Komplettering/korrigering av aspekter kring hantering Lista över filer och dokumentation som ska bevaras, olika beslut som fattas inför slutfasen, åtgärder innan tillgängliggörande etc. Beslut och rutiner kring tillgängliggörande, t.ex. information om hur citering ska anges i samband med sekundäranalys av materialet. Fältanteckningar Kodbok/variabellista, statistikfiler Dokumentationsprogram Teknisk rapport/metodbeskrivning Analysplan Kodbok, variabellista Analysloggbok, programkodfiler/syntaxer/loggfil, readme.txt fil, basschema

25 Fas i forskningsprocessen Väsentligt att dokumentera (exempel) 1 Projektplanering Information om det planerade forskningsprojektet såsom frågeställningar, syfte, metodik etc. Plan för hur materialet är tänkt att hanteras och bevaras. Ansvarsområden, beslut, och löpande anteckningar. Stöd för att strukturera dokumentationen (exempel) Forskningsbeskrivning/Forskningsplan/ Forskningsprotokoll Datahanteringsplan () 2 Samla in och organisera 3 Analysera & publicera resultat 4 Bevara och förbereda 5 Tillgängliggöra Löpande anteckningar under projektet t.ex. i samband med insamling av, beslut som fattas, kontakter som tas, etc. Beskrivning av forskningsprojektets, hur har rensats, bearbetats etc. Beskrivning av metoder såsom urvalsmetod, insamlingsmetod, verktyg/instrument etc. Kompletterande beskrivningar om hantering (principer för versionering, mappstruktur, filnamn etc) Överblick av analysarbetet (frågeställningar, medförfattare, variabler, beslut etc.) Beskrivning av variabler i fil som används för analys Beskrivning om hur analyser utförs (i statistikprogram) Överblick av filer och hur de hänger ihop etc. Komplettering/korrigering av aspekter kring hantering Lista över filer och dokumentation som ska bevaras, olika beslut som fattas inför slutfasen, åtgärder innan tillgängliggörande etc. Beslut och rutiner kring tillgängliggörande, t.ex. information om hur citering ska anges i samband med sekundäranalys av materialet. Fältanteckningar Kodbok/variabellista, statistikfiler Dokumentationsprogram Teknisk rapport/metodbeskrivning Analysplan Kodbok, variabellista Analysloggbok, programkodfiler/syntaxer/loggfil, readme.txt fil, basschema

26 Fas i forskningsprocessen Väsentligt att dokumentera (exempel) 1 Projektplanering Information om det planerade forskningsprojektet såsom frågeställningar, syfte, metodik etc. Plan för hur materialet är tänkt att hanteras och bevaras. Ansvarsområden, beslut, och löpande anteckningar. 2 Samla in och organisera 3 Analysera & publicera resultat 4 Bevara och förbereda 5 Tillgängliggöra Löpande anteckningar under projektet t.ex. i samband med insamling av, beslut som fattas, kontakter som tas, etc. Vilken dokumentation är viktig för sekundäranvändare av? Beskrivning av forskningsprojektets, hur har rensats, bearbetats etc. Beskrivning av metoder såsom urvalsmetod, insamlingsmetod, verktyg/instrument etc. Kompletterande beskrivningar om hantering (principer för versionering, mappstruktur, filnamn etc) Överblick av analysarbetet (frågeställningar, medförfattare, variabler, beslut etc.) Beskrivning av variabler i fil som används för analys Beskrivning om hur analyser utförs (i statistikprogram) Överblick av filer och hur de hänger ihop etc. Komplettering/korrigering av aspekter kring hantering Lista över filer och dokumentation som ska bevaras, olika beslut som fattas inför slutfasen, åtgärder innan tillgängliggörande etc. Beslut och rutiner kring tillgängliggörande, t.ex. information om hur citering ska anges i samband med sekundäranalys av materialet. Stöd för att strukturera dokumentationen (exempel) Forskningsbeskrivning/Forskningsplan/ Forskningsprotokoll Datahanteringsplan () Fältanteckningar Kodbok/variabellista, statistikfiler Dokumentationsprogram Teknisk rapport/metodbeskrivning Analysplan Kodbok, variabellista Analysloggbok, programkodfiler/syntaxer/loggfil, readme.txt fil, basschema

27 Övning - fallbeskrivning Forskningsprojektet kommer att samla in via enkäter och fysiska mätningar i samband med en hälsoundersökning på en vårdcentral. Projektet har ännu inte startat insamlingen. Forskargruppen har påbörjat en hanteringsplan men har lite funderingar kring delen som avser dokumentation och meta. De vill gärna ha lite råd om vad de bör tänka på i samband med dokumentation under insamlings- och analysfasen. - Vilka råd kan du ge till forskargruppen? SND Svensk nationell tjänst

28 Övning - fallbeskrivning Några möjliga råd: Beskriv insamlingen (enkäter och undersökningar): vad, hur, när, av vem Dokumentera löpande under projektets gång, t.ex. i en Forskningsprojektet kommer att samla in via enkäter och loggbok fysiska mätningar i samband med en hälsoundersökning på en vårdcentral. Projektet har ännu inte startat insamlingen. Forskargruppen har påbörjat en hanteringsplan men har lite funderingar kring delen till vilka som analyser avser dokumentation och meta. De vill gärna ha lite råd om vad de bör tänka på i samband med dokumentation filnamn, versionering, under insamlingsmappstrukturoch analysfasen. Ange hur rensats och bearbetats (vad, hur, när, av vem) Under analysfasen; dokumentera vilka filer som använts Klargör vilka rutiner som ska följas med hänseende till Använd en hanteringsplan för att beskriva rutiner kring projektets dokumentation (vilka dokument/verktyg som används till vilka syften, vem som ansvarar etc.) och - Vilka råd kan du ge till forskargruppen? principer för att namnge filer, versionera och skapa mappstrukturer Etc. SND Svensk nationell tjänst

29 Sammanfattningsvis Vilken dokumentation som behövs beror på projektets specifika förutsättningar. Forskarstöd kring dokumentation kan utgå från forskningsprocessens olika steg. Viktiga råd till forskare: börja dokumentera tidigt skapa rutiner fundera på vad andra behöver veta för att kunna återanvända materialet. SND Svensk nationell tjänst

30 Övergripande principer för dokumentation SND Svensk nationell tjänst