Aller au contenu principal

Bonnes pratiques à adopter

+ Nom des fichiers

Voici 3 règles à suivre pour définir une convention de nommage pour les documents que vous allez créer. Les bons noms de fichiers sont : 

  •  consistants;
  • significatifs pour vous et vos collègues;
  • permettent de trouver facilement les fichiers. 

 

Choisir le bon terme 

  • Déterminer le sujet du document et l’exprimer sous forme de mots clés. Un à trois mots significatifs. 
  • Donner un nom de fichier qui doit permettre l’identification du sujet principal d’un document sans avoir à ouvrir le fichier pour le consulter. 
  • Limiter la longueur du nom de fichier à 20-25 caractères max. 
  • Organiser les mots-clés en respectant le principe du général au particulier. Le sujet principal sera donc présenté en premier dans le nom du fichier. 

ATTENTION :

  • Proscrire l’utilisation d’une phrase complète comme nom de fichier.
  • Si l’année est importante débuté par cette dernière. 

 

Les caractères permis pour les fichiers :

  • Utiliser les tirets bas _ pour combler les espaces entre les mots. 
  • Faciliter le tri numérique en utilisant les formats de date : AAMMJJ ou AA-MM-JJ
  • Utiliser les abréviations qui sont admises (voir documents liste des abréviations admises). 
  • Faciliter le tri numérique en utilisant le 0 devant les nombres de 1 à 9. 
  • Pour un document final : privilégier un format de sauvegarde qui permettra d’assurer authenticité et intégrité (.PDF, .PDF-a). 

Attention : 

Exclure l’utilisation les virgules, points, apostrophes, caractères accentués (é, è, ê, à, etc.), les caractères spéciaux (? & % * ! | #...) et des espaces. 

 

Source: Laure Perrier, University of Toronto

 

Exemples de noms de fichiers:

  • MCIM_Proposal_0.9.doc
  • PressHouseUserManual-01.02.doc

ASTUCE:

 

Si vous avez déjà plusieurs fichiers et que vous souhaitez les renommer, vous pouvez utiliser un de ces logiciels:

 

+ Formats des fichiers

Format des fichiers

Voici les formats à privilégier: 

Type de données

Formats recommandés

Formats acceptables

Données tabulaires avec des métadonnées complètes

étiquettes de variables, étiquettes de code et valeurs manquantes définies

Format portable SPSS (.por)

texte délimité et fichier de commande ('setup') (SPSS, Stata, SAS, etc.)

texte structuré ou fichier de balisage d'informations de métadonnées, par ex. Fichier XML DDI

formats propriétaires de progiciels statistiques: SPSS (.sav), Stata (.dta), MS Access (.mdb / .accdb)

Données tabulaires avec des métadonnées minimales

en-têtes de colonnes, noms de variables

valeurs séparées par des virgules (.csv)

fichier délimité par des tabulations (.tab)

texte délimité avec instructions de définition de données SQL

texte délimité (.txt) avec des caractères non présents dans les données utilisées comme délimiteurs

formats largement utilisés: MS Excel (.xls / .xlsx), MS Access (.mdb / .accdb), dBase (.dbf), feuille de calcul OpenDocument

Données géospatiales

données vectorielles et raster

ESRI Shapefile (.shp, .shx, .dbf, .prj, .sbx, .sbn facultatif)

TIFF géoréférencé (.tif, .tfw)

Données CAO (.dwg)

données attributaires tabulaires du SIG

Langage de balisage géographique (.gml)

Format de la base de données géospatiales ESRI (.mdb)

MapInfo Interchange Format (.mif) pour les données vectorielles

Langage de balisage Keyhole (.kml)

Adobe Illustrator (.ai), données CAO (.dxf ou .svg)

formats binaires des packages SIG et CAO

Données textuelles

Format de texte enrichi (.rtf)

texte brut, ASCII (.txt)

Texte en langage de balisage extensible (.xml) selon une définition de type de document (DTD) ou un schéma approprié

Langage de balisage hypertexte (.html)

formats largement utilisés: MS Word (.doc / .docx)

certains formats spécifiques au logiciel: NUD * IST, NVivo et ATLAS.ti

Image

TIFF 6.0 non compressé (.tif)

JPEG (.jpeg, .jpg, .jp2) si l'original a été créé dans ce format

GIF (.gif)

TIFF autres versions (.tif, .tiff)

Format d'image RAW (.raw)

Fichiers Photoshop (.psd)

BMP (.bmp)

PNG (.png)

Format de document portable Adobe (PDF / A, PDF) (.pdf)

Audio

Codec audio sans perte gratuit (FLAC) (.flac)

MPEG-1 Audio Layer 3 (.mp3) si l'original a été créé dans ce format

Format de fichier d'échange audio (.aif)

Format audio de forme d'onde (.wav)

Video

MPEG-4 (.mp4)

OGG video (.ogv, .ogg)

motion JPEG 2000 (.mj2)

AVCHD video (.avchd)

Documentation et scripts

Format de texte enrichi (.rtf)

PDF/UA, PDF/A or PDF (.pdf)

XHTML or HTML (.xhtml, .htm)

OpenDocument Text (.odt)

Texte brut (.txt)

formats largement utilisés: MS Word (.doc/.docx), MS Excel (.xls/.xlsx)

Texte balisé XML (.xml) selon une DTD ou un schéma approprié, par ex. XHMTL 1.0

 

Traduction de  : UK Data - Recommended formats

    • Choississez des formats ouverts et faciles à réutiliser.
    • Privilégier un format de conservation qui facilite l’interopérabilité, la lisibilité et l’accessibilité à long terme des fichiers. Par exemple, un document Word pourra être sauvegardé sous un format .rtf. 
    • Sauvegarder un document final en format .pdf-a, .pdf, ou .tiff qui permet d’assurer authenticité et intégrité (.PDF, .PDF-a). 
    • Favoriser les formats:
      • Non-propriétaire
      • Sans perte
      • Normalisé dans le domaine ou d’usage courant dans le milieu de la recherche
      • Incluez les étiquettes des données (métadonnées)
      • Adhérant à une norme ouverte et documentée
      • Intéropérable parmi diverses plateformes et applications
      • Publié intégralement et disponible libre de redevances
      • Applicable entièrement et indépendamment par plusieurs fournisseurs de logiciels sur plusieurs plateformes, sans aucune restriction de propriété intellectuelle pour la technologie requise
      • Conçu et maintenu par un organisme de normes ouvertes ayant un processus inclusif et bien défini pour l’évolution de la norme.

+ Contrôle des versions

Contrôle des versions

Le contrôle de version est le moyen de suivre les révisions d'un ensemble de données. Si votre recherche implique plus d'une personne, elle est essentielle.

Vous voudrez enregistrer chaque modification dans un fichier, quelle que soit sa taille. Gardez une trace des modifications apportées à un fichier dans votre convention de dénomination de fichier ou dans votre logiciel de contrôle de version. Un logiciel de partage de fichiers peut également être utilisé pour suivre les versions.

Vous pouvez le faire manuellement en incluant un indicateur de contrôle de version dans le nom du fichier et dans le fichier lui-même. Insérer une mention de version si nécessaire pour distinguer les versions de travail, finales, approuvées, etc. Pour un travail collaboratif, on peut effectuer un contrôle des versions en identifiant:

 

Vous pouvez créer un tableau de contrôle comme celui-ci pour vous aider ;a suivre l'évolution de vos fichiers:

Numéro de version Auteur Changement Date
0.1 S. Smith, Post-Doc Première ébauche 2019-01-09
0.2 F. Hill, Post-Doc Conclusion révisée 2019-01-14
0.3 G. Joe, PI Introduction révisée 2019-01-16

Il existe plusieurs logiciels conçus pour gérer le suivi des versions:  MercurialTortiseSVNApache SubversionGit, et SmartSVN.

Un logiciel de partage de fichiers peut également être utilisé pour suivre les versions. UVaBox a des options pour suivre les versions majeures et mineures des fichiers. Google Docs enregistre également les modifications de version.

 

    • le contributeur
    • la date de la version
    • le numéro de la version, tel que v01, v02, v1.4. La convention standard est d'utiliser des nombres entiers pour les révisions majeures et des nombres décimaux pour les révisions mineures. Employez une numérotation séquentielle pour les ébauches (0.1, 0.2, 0.3) jusqu'à ce que vous soyez à la version définitive.La version définitive sera le version 1.0. Si vous apportez des modifications, numérotez les version 1.1,  1.2, 1.3, jusqu'à la prochaine version définitive 2.0. 
    • Une combinaison de ces éléments.

+ Structure des dossiers

Les bonnes pratique pour la structuration des dossiers

Source: Laure Perrier, University of Toronto

    • Limitez l’étendue des dossiers à trois ou à quatre niveaux
    • Envisagez de limiter à dix le nombre de dossiers contenus dans chacun de vos dossiers
    • Incluez un dossier de « documentation » dans l’organisation de vos dossiers. Ce dossier pourrait inclure :
      • Des propositions de projet ou des protocoles
      • Des formulaires de consentement ou d’approbation
      • Des documents de méthodologie
      • Un plan de gestion des données
      • Le code employé pour le recodage, les analyses et les résultats
      • Des fichiers Readme (lisezmoi) comportant des renseignements de transformation
      • Des fichiers Readme (lisezmoi) comportant les noms ou les titres au complet des abréviations utilisées dans un nom de fichier
      • Des livres de codes ou des guides