BCW-1 Recommandations générales pour le codage web

Noms de fichiers

Version : 1.0.1, date : , permalink : https://yannisdelmas.github.io/beau-code-web/guide-generalites.html#noms-fichiers

Les noms des fichiers et dossiers utilisés sur le web doivent respecter les règles suivantes.

  1. Écriture recommandée en kebab-case, sans espace, ni accent (é → e), ni diacritique (ç → c), ni caractère spécial, ni ponctuation.

  2. Il est recommandé de ne pas dépasser 32 caractères, extension comprise.

  3. Les mots employés devraient refléter de façon claire et compréhensible le contenu ou la fonction dans le site du fichier ou dossier. Il convient donc d’éviter des mots très génériques, tels que page ou article, ou trop ambigus. On devrait également éviter les stop words (articles, conjonctions…), qui allongent l’URL sans apporter de contenu sémantique.

  4. Une ou plusieurs extensions doivent indiquer le format d'un document.

Justification

  1. respect des standards Les adresses web sont définies par le document Uniform Resource Identifier (URI): Generic Syntax [RFC 3986]. Le chemin est sensible à la casse. Comme certains systèmes d’exploitation n’y sont pas sensibles, pour éviter des liens brisés et des erreurs dans l’arborescence, il est habituel de se limiter à des minuscules, même si on pourrait contourner ces difficultés en formulant une règle plus précise. Les caractères autres qu’alphanumériques, -, ., _ et ~ sont recodés. Les caractères . et ~ ayant une signification particulière dans certains contextes et le souligné _ n’étant pas traité comme un séparateur par les moteurs de recherche (cf. Web Rank Info : Référencement naturel : dans les URL, le tiret meilleur que l’underscore), les seuls caractères toujours sûrs pour un nom de fichier ou dossier, hors extension, sont les lettres, les chiffres et le tiret -.

    lisibilité Pour gagner en lisibilité des adresses, l’habitude est de remplacer tout caractère susceptible d’être encodé dans les bares d’adresse et dans la transcription des URL, par exemple pour des bibliographies. Ceci inclut dont les espaces, les accents et certains caractères spéciaux.

  2. maintenabilité Plusieurs des systèmes de fichiers et ou explorateurs de fichiers ont une limitation d'environ 250 caractères Unicode (les URL ont une limite supérieure). Toutefois, pour permettre un archivage sur disque optique, il faut adopter la limite du système de fichiers UDF, qui limite les chemins à à 127 caractères Unicode [Wikipedia UDF].

    lisibilité Nombre d’explorateurs de fichiers des OS ont, par défaut, une configuration ni n’affiche qu’une vingtaine à une trentaine de caractères.

  3. respect des standards Cette règle découle du respect des méthodes d’indexation des moteurs de recherche. Sur le référencement naturel (SEO) et sa dimension technique, cf. [TechSEO]. On notera que les stop words sont purement et simplement ignorés par l’indexation des moteurs de recherche web.

    service Ceci rend également les URL plus simple à retenir et, le cas échéant, à transcrire, pour les utilisateurs.

    maintenabilité La persistance des chemins aide à maintenir l’arborescence d’un site.

  4. lisibilité Mettre une extension et l’afficher limite les risques d’erreurs de format.

    respect des standards Nombre de serveurs sont paramétrés pour inférer le format des documents à partir de leurs extensions [Apache Mod_mime].