Guida alla documentazione dei dati di ricerca
Scopo: Questa guida fornisce agli autori istruzioni dettagliate su come documentare correttamente i dati della ricerca, facilitandone la comprensione, l'uso e il riutilizzo da parte della comunità scientifica e del pubblico in generale.
Ambito di applicazione: Si applica a tutti i dati di ricerca, compresi i dati quantitativi e qualitativi, gli insiemi di dati grandi e piccoli e i materiali correlati, come i codici software e i protocolli, presentati insieme ai manoscritti in PpA
Principi di base della documentazione
1. Chiarezza: la documentazione deve essere chiara e di facile comprensione.
2. Completezza: includere tutte le informazioni necessarie per comprendere, valutare e utilizzare i dati.
3. Accessibilità: garantire che la documentazione sia facilmente accessibile insieme al set di dati.
Elementi essenziali della documentazione
Metadati descrittivi
- Titolo del set di dati: Chiaro e descrittivo, che rifletta il contenuto del set di dati.
- Autore/i: nomi completi e istituzioni di coloro che hanno generato i dati.
- Data di creazione: quando i dati sono stati generati o raccolti.
- Versione: se applicabile, la versione del set di dati.
- Posizione: Repository in cui sono ospitati i dati e il loro identificatore persistente (ad es. DOI).
Contesto dei dati
- Descrizione generale: spiegazione di cosa sono i dati e per quale ricerca sono stati generati.
- Parole chiave: termini che facilitano la ricerca e il recupero del set di dati.
- Copertura temporale e geografica: il periodo e la posizione geografica dei dati.
Metodologia
- Raccolta ed elaborazione dei dati: Descrivere come sono stati raccolti, elaborati e analizzati i dati.
- Standard e calibrazioni: Eventuali standard utilizzati o calibrazioni eseguite.
- Strumentazione e software: dettagli su eventuali apparecchiature o software specializzati utilizzati.
Struttura e formato dei dati
- Formato del file: specificare il formato dei dati e le ragioni della scelta.
- Struttura dei dati: Descrivere l'organizzazione dei dati, compresa la descrizione delle variabili, dei codici e delle unità di misura.
Accesso e utilizzo
- Licenza d'uso: dettagli sulle modalità di utilizzo dei dati, comprese le eventuali restrizioni.
Guida all'accesso: come accedere ai dati e al software necessario per la visualizzazione o l'analisi.
Assistenza e contatti
- Contatto di supporto: informazioni di contatto per domande o chiarimenti sui dati.
Migliori pratiche
- Utilizzare standard di metadati riconosciuti per facilitare l'interoperabilità.
- Includere esempi di citazione e riutilizzo dei dati.
- Garantire la privacy e l'etica, soprattutto per i dati sensibili.
Conclusione: una corretta documentazione dei dati è fondamentale per la trasparenza, la replicabilità e il progresso della conoscenza scientifica. [Nome della rivista] incoraggia gli autori a seguire queste linee guida per massimizzare l'impatto e l'accessibilità delle loro ricerche.
