Gestion des données de recherche: Documenter son projet et ses processus

Documenter son projet et ses processus

Une bonne documentation permet à vous, aux membres de votre équipe de recherche ainsi qu’à vos possibles collaborateurs de bien comprendre vos données et facilite le partage d’une compréhension commune aujourd’hui au sein de l’équipe et possiblement dans le futur si les données sont partagées. Elle aide à se prémunir d'une interprétation erronée des résultats de recherche ou d'une mauvaise utilisation des données. Notons aussi que la forme que prend la documentation peut varier selon le domaine de recherche. Il est essentiel de mettre à jour la documentation au fil du projet. L'utilisation d'un PGD peut faciliter l'élaboration de la documentation.

Les sections ci-dessous présentent des éléments importants à considérer pour assurer une documentation adaptée qui facilitera le repérage de l’information, le partage des données au sein de l’équipe de recherche et leur possible réutilisation tout en veillant à leur assurer une pérennité tout au long de leur vie utile.

Exemples d’éléments à documenter :

• les hypothèses formulées;
• l’approche méthodologique utilisée;
• les types et procédures d’analyse;
• la description des données recueillies;
• le dictionnaire des données qui définit les variables utilisées ainsi que les objets;
• les concepts clés, les vocabulaires, les systèmes de classification;
• les unités de mesure;
• les outils ou logiciels utilisés, les codes sources;
• les renseignements sur les personnes ayant travaillé au projet et réalisé chacune des tâches;
• les fichiers Lisez-moi (readme) qui décrivent le contexte des jeux de données, leur structure, les droits, les limites d’utilisation, etc.