Guide Stylistique

Ce guide stylistique, adapté du Handbook style guide de drupal.org, vise à améliorer la qualité des pages de documentation rédigées par et pour la communauté française sur notre site. Nous invitons tous les contributeurs à suivre ces recommandations lors de la rédaction ou la mise à jour des documentations.

1. Titres

1. Utiliser un titre court, concis. Les mots drupal et document ne sont le plus souvent pas utiles dans un titre.
2. Seule la première lettre du titre devrait être en majuscule sauf s'il s'agit d'un nom propre.
3. Utiliser "HOWTO: " lorsqu'il s'agit d'un tutoriel précis.

2. Contenu

1. Eviter les pronoms personnels (Je, mon, notre, nous, etc).
2. Rester concis et précis le plus possible.
3. Eviter de créer un document sur un sujet qui a déjà été traité.
4. Utiliser un espace simple après une virgule.
5. Vérifier l'orthographe.

3. Terminologie

Utilisez :

1. Drupal et non drupal
2. e-mail et non email
3. HTML et non html
4. URL et non url
5. PHP et non php
6. MySQL
7. JavaScript

4. Liens

1. Pour décrire comment accéder à une certaine option de configuration dans Drupal (par exemple ajouter un vocabulaire), spécifier le chemin sous la forme :

   chemin complet (fil d'ariane)

   Par exemple : admin/content/taxonomy/add/vocabulary (Administrer > Gestion du contenu > Catégories > Ajouter un vocabulaire).

2. Ne pas utiliser pour cela d'abréviations (ne pas écrire Admin au lieu de Administrer).

3. Les items de menu peuvent être déplacés, toujours préciser le chemin complet.