Guide pour la documentation des données de recherche

Objectif: Ce guide fournit aux auteurs des instructions détaillées sur la manière de documenter correctement les données de recherche, afin de faciliter leur compréhension, leur utilisation et leur réutilisation par la communauté scientifique et le grand public.

Champ d'application: Ce guide s'applique à toutes les données de recherche, y compris les données quantitatives et qualitatives, les ensembles de données petits et grands, et les documents connexes tels que les codes logiciels et les protocoles, soumis avec les manuscrits dans PpA

Principes de base de la documentation

1) Clarté : la documentation doit être claire et facile à comprendre.
2. Exhaustivité : inclure toutes les informations nécessaires à la compréhension, à l'évaluation et à l'utilisation des données.
3. Accessibilité : veiller à ce que la documentation soit facilement accessible avec l'ensemble des données.

Éléments essentiels de la documentation

Métadonnées descriptives

- Titre de l'ensemble de données : Clair et descriptif, reflétant le contenu de l'ensemble de données.
- Auteur(s) : noms complets et institutions des personnes qui ont généré les données.
- Date de création : date à laquelle les données ont été générées ou collectées.
- Version : Le cas échéant, la version de l'ensemble de données.
- Emplacement : dépôt où les données sont hébergées et son identifiant permanent (p. ex. DOI).

Contexte des données

- Description générale : explication de la nature des données et de la recherche pour laquelle elles ont été générées.
- Mots clés : termes qui facilitent la recherche et l'extraction de l'ensemble de données.
- Couverture temporelle et géographique : la période et la localisation géographique des données.

Méthodologie

- Collecte et traitement des données : Décrire comment les données ont été collectées, traitées et analysées.
- Normes et étalonnages : Toutes les normes utilisées ou tous les étalonnages effectués.
- Instrumentation et logiciels : détails de tout équipement ou logiciel spécialisé utilisé.

Structure et format des données

- Format de fichier : préciser le format des données et les raisons de son choix.
- Structure des données : Décrire l'organisation des données, y compris la description des variables, des codes et des unités de mesure.

Accès et utilisation

- Licence d'utilisation : détails sur la manière dont les données peuvent être utilisées, y compris les restrictions éventuelles.
- Guide d'accès : comment accéder aux données et à tout logiciel nécessaire à la visualisation ou à l'analyse.

Support et contact

- Contact pour l'assistance : informations de contact pour les questions ou les clarifications concernant les données.

Meilleure pratique

- Utiliser des normes de métadonnées reconnues pour faciliter l'interopérabilité.
- Inclure des exemples sur la manière de citer et de réutiliser les données.
- Garantir le respect de la vie privée et de l'éthique, en particulier pour les données sensibles.

Conclusion: une documentation correcte des données est essentielle à la transparence, à la reproductibilité et à l'avancement des connaissances scientifiques. La revue [Nom de la revue] encourage les auteurs à suivre ces lignes directrices afin de maximiser l'impact et l'accessibilité de leur recherche.