Chapitre 10.  Style

Pour conserver une certaine cohérence entre le travail des nombreux rédacteurs de la documentation de FreeBSD, on a défini quelques règles à suivre.

N'utilisez pas de formes contractées

N'utilisez pas de formes contractées. Utilisez toujours les mots entiers. “Don't use contractions” n'est pas correct[5].

Ne pas contracter donne au texte un ton plus formel, est plus précis, et facilite la tâche des traducteurs.

Utilisez la virgule dans les énumérations

Dans une énumération au sein d'un paragraphe, séparez avec des virgules les éléments les uns des autres. Mettez aussi un virgule et la conjonction “et” avant le dernier élément.

Examinez par exemple la phrase suivante :

C'est une liste d'un, deux et trois éléments.

Est-ce une liste de trois éléments, “un”, “deux”, et “trois”, ou une liste de deux éléments, “un” et “deux et trois” ?

Il vaut mieux être explicite et ajouter la dernière virgule :

C'est une liste d'un, deux, et trois éléments.

Evitez les redondances

Evitez les redondances. En particulier, “la commande”, “le fichier”, et “man commande” sont probablement redondants.

Voici deux exemples pour ce qui concerne les commandes. Il est préférable d'utiliser le second.

Utilisez la commande cvsup pour mettre à jour vos sources.

Utilisez cvsup pour mettre à jour vos sources.

Voici deux exemples pour ce qui concerne les noms de fichiers. Il est préférable d'utiliser le second.

… dans le fichier /etc/rc.local

… dans /etc/rc.local

Voici enfin deux exemples pour les références aux pages de manuel. Il est préférable d'utiliser le second (il emploie citerefentry).

Voyez man csh pour plus d'information.

Voyez csh(1)

Pour des détails sur le style, consultez les Eléments de Style, de William Strunk.



[5] N.d.T.: Ceci s'applique bien sûr aux textes rédigés en anglais.

Ce document, ainsi que d'autres peut être téléchargé sur ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/

Pour toutes questions à propos de FreeBSD, lisez la documentation avant de contacter <questions@FreeBSD.org>.

Pour les questions sur cette documentation, contactez <doc@FreeBSD.org>.