Submitted by tomdeb on
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
- Utiliser un titre court, concis. Les mots drupal et document ne sont le plus souvent pas utiles dans un titre.
- Seule la première lettre du titre devrait être en majuscule sauf s'il s'agit d'un nom propre.
- Utiliser "HOWTO: " lorsqu'il s'agit d'un tutoriel précis.
2. Contenu
- Eviter les pronoms personnels (Je, mon, notre, nous, etc).
- Rester concis et précis le plus possible.
- Eviter de créer un document sur un sujet qui a déjà été traité.
- Utiliser un espace simple après une virgule.
- Vérifier l'orthographe.
3. Terminologie
Utilisez :
- Drupal et non drupal
- e-mail et non email
- HTML et non html
- URL et non url
- PHP et non php
- MySQL
- JavaScript
4. Liens
-
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).
-
Ne pas utiliser pour cela d'abréviations (ne pas écrire Admin au lieu de Administrer).
- Les items de menu peuvent être déplacés, toujours préciser le chemin complet.