Documenter son projet et ses processus
Une documentation rigoureuse permet à vous, à votre équipe de recherche et à vos collaboratrices et collaborateurs de mieux comprendre vos données et d’assurer une vision commune, tant au sein du projet qu’à long terme, si les données sont partagées. Elle réduit le risque d’interprétations erronées des résultats et de mauvaise utilisation des données.
La forme de la documentation peut varier selon le domaine de recherche, mais il est essentiel de la mettre à jour régulièrement tout au long du projet. L’adoption d’un plan de gestion des données (PGD) peut grandement faciliter son élaboration et son maintien.
La documentation doit faciliter le repérage de l’information, le partage des données au sein de l’équipe de recherche et leur réutilisation potentielle, tout en garantissant leur pérennité tout au long de leur cycle de vie.
Les sections suivantes mettent en évidence les éléments clés à prendre en compte pour élaborer une documentation efficace.
Exemples d’éléments à documenter
- Hypothèses formulées
- Approche méthodologique utilisée
- Types et procédures d’analyse
- Description des données recueillies
- Dictionnaire des données qui définit les variables utilisées ainsi que les objets
- Concepts clés, vocabulaires, systèmes de classification
- Unités de mesure
- Outils ou logiciels utilisés, codes sources
- Renseignements sur les personnes ayant travaillé au projet et réalisé chacune des tâches
- Fichiers Lisez-moi (readme) qui décrivent le contexte des jeux de données, leur structure, les droits, les limites d’utilisation, etc.
Pour en apprendre davantage sur les pratiques courantes de documentation des données de recherche, nous vous invitons à consulter la vidéo de l'Université McGill : Pratiques courantes en documentation.