I et forskningsprosjekt er det å ha gode filnavn, filformater og en god mappestruktur med på å gi god oversikt, noe som igjen er tidsbesparende.
Filformat
Vi anbefaler å bruke åpne og/eller arkivverdige filformater. Dette bidrar til at data kan åpnes og brukes i fremtiden. Data som er lagret i et proprietært format kan hindre deg og andre i å få tilgang til dataen senere.
Filnavn
Filnavn skal være korte og beskrivende og generell informasjon skal komme først. Tenk over hva du vil søke på for å finne en fil. Filer sorteres numerisk eller alfabetisk i en mappe, bruk derfor dato i begynnelsen om dette er relevant.
- Bruk _ eller - for å skille ord, aldri mellomrom
- Unngå spesialtegn som Æ, Ø, Å, #, %, &, “ og lignende
Eksempler på hva som kan være fornuftig å inkludere i et filnavn er:
- Dato og tidspunkt som er relevante for filens innhold
- dato skrives baklengs (ÅÅÅÅMMDD)
- Navn på prosjekt eller eksperiment
- Kort informasjon om innholdet i filen
- Navn eller initialer på forsker
- Unik identifikator som nummer på eksperiment eller en serie
- Til sist står versjonsnummer på filen
- Skriv nummer med likt antall tall, 01 eller 001
Gode filnavn inneholder mye informasjon. Det kan være lurt å skrive ut denne: hva datoen er for, hvilke prosjekt akronymet tilhører, hvilken forsker som er bak ulike initialer og så videre i en readme-fil.
Mappestruktur
Anbefalinger for en god mappestruktur:
- Planlegg en struktur det er mulig å skalere underveis.
- Lag gode, deskriptive mappenavn.
- Bruk undermapper heller enn store generelle mapper.
- La mappestrukturen følge arbeidsflyten i prosjektet.
- Holde aktive og ferdige deler av et prosjekt adskilt.
CodeRefinery har eksempel på hvordan en mappestruktur bør settes opp.