Tutorial définition et règles pour la convention de nommage des fichiers et dossiers

Définition et les objectifs d'une convention de nommage dans un projet.

La convention de nommage est l'ensemble de règles qui définissent la syntaxe utilisée pour nommer les éléments fichiers, dossiers, balises, variables, tables, constantes, classes, fonctions... d'un projet. Cette convention de nommage sera partagée par l'ensemble des différents pôles de l'équipe projet : pôle  programmeur, pôle graphiste, pôle éditorial et pôle gestion de projet.

Les trois objectifs de la convention de nommage

• faciliter le travail en collaboration : partager l'information, être rapidement lisible et compréhensif par toute l'équipe projet.
• optimiser la production : éviter les doublons, gagner du temps donc de l'argent..
• optimiser le SEO, le référencement naturel : être sur la première page des moteurs de recherche.

Il faut donc définir les différentes règles de convention de nommage :

Pour le travail collaboratif :

• le choix de la langue : anglais ou français,
• le principe du choix des mots clefs pour nommer les fichiers/les dossiers,
• le principe de l'arborescence et du placement des fichiers. A savoir si l'ensemble des fichiers (images, texte,...) sont dans le même dossier ou alors si on effectue un dossier par médias.
• la relation entre les dossiers/fichiers sources et dossiers/fichiers data,
• la relation de l'organisation entre les dossiers/fichiers sources et les dossiers/fichiers projet. A savoir si l'architecture du projet est identique à l'arborescence du projet à développer ou différente,
• le choix pour la séparation des mots et la gestion des espaces : -,_, MajusculeAuDébutDeChaqueMot ou pas-de-majuscule-au-début-de-chaque-mot, car les espaces sont non supportés par PHP et Action script si le logiciel Flash est utilisé dans le développement.
• la non-utilisation des caractères spéciaux.

Pour le pôle développement

• l'organisation des noms, des dossiers et des calques dans Flash si logiciel utilisé, pour Photoshop
• la nomenclature CSS,
• l'organisation des commentaires du code: date, auteur, modification apportée, 
• mise en forme du code: nombres de caractère par ligne, indentation et accolade, séparation des groupes actions,... 
• le principe de nommage des variables, des tables de la BDD, des classes, des fonctions, des constantes,...
• nombre de caractères maximum par lignes.

Pour le SEO et le référencement naturel :

Le principe du choix des mots clefs pour les balises méta :

• balise title, 
• balise description,
• balise keywords,
• balise robot
• le texte alternatif avec la balise Alt, 
• les liens a Href.