Charte code de qualité.

Objectif de la charte.

Pour le suivi de ses clients, pour être facilement relue et pour faciliter la maintenance des sites internet, PC Solutions & Services a créé la charte "Code de qualité".
Avoir un code bien présenté permet de diminuer le temps de développement, mais surtout de revenir facilement sur le code pour le modifier ou l'améliorer.

Description.

Règles obligatoires.

• Tout le code doit être indenté et ce avec 2 espaces.
• Le code ne doit pas contenir plus d'une accolade d'ouverture ou de fermeture par ligne (sauf une de chaque).
• Le code doit être commenté en français.
  Les commentaires doivent décrire ce qui se passe et non comment ça se passe.
• Les fonctions doivent être utilisées pour tout code identique à une valeur près.
• Les fonctions doivent être commentées ainsi que les codes retour.
• Les variables doivent porter des noms représentatifs
• Chaque fichier doit contenir son nom et son utilité.
• Les codes affichés par le navigateur doivent être accessibles aux handicapés utilisant des fureteurs braille, texte ou vocaux.
• Toutes les pages créées par PC Solutions & Services doivent être validées par le W3C et ceci dans une logique de qualité plutôt que commerciale.
  Des exceptions pourront être accordés pour les scripts extérieurs (googles, partenaires, apparats).
  Avoir des pages validées XHTML c'est avoir des pages qui s'affichent bien sur tous les navigateurs et pour longtemps.

1. Nom et description du fichier
2. Déclaration et description des variables
3. Fonctions
4. Programme

Structure du site.

• Les fichiers doivent être placés dans des répertoires significatifs.
  Il n'y a aucune limite concernant le nombre de répertoires.
• Un plan du site comportant tous les fichiers et une description sommaire de leur contenu est demandé.
  Evidement celui-ci ne sera pas mis à la disposition du public.

Conseils.

• Il est conseillé, pour le développement, d'utiliser un organigramme.
  Celui-ci est un bon compagnon de route.
• Les sites de références et les ouvrages où des scripts (ou parties de scripts) auront été trouvés doivent être indiqués dans des commentaires et éventuellement dans une page type "partenaires".