Les interfaces et la documentation Discourse font actuellement l’objet d’un examen et d’une modification afin de s’aligner sur ces directives. Nous travaillons à un alignement complet dans les plus brefs délais.
Lorsque vous écrivez pour Discourse, prenez note des directives suivantes pour la mise en forme du texte. Ces directives s’appliquent au texte dans tous les domaines, notamment la documentation et l’interface utilisateur de Discourse.
Majuscules
Lorsque vous rédigez de la documentation ou du texte d’interface utilisateur, utilisez par défaut la casse de phrase (c’est-à-dire que la première lettre de la phrase est capitalisée et rien d’autre).
Rappels importants :
- Les titres, les en-têtes et les noms de catégories utilisent la casse de phrase.
- Les noms des fonctionnalités de Discourse ne sont pas capitalisés, à l’exception des suivants :
- Explorateur de données
N’utilisez aucune autre mise en forme pour les noms de fonctionnalités, y compris aucun gras, italique, guillemets inversés, guillemets ou quoi que ce soit d’autre.
Les exceptions de majuscules incluent :
- Les acronymes doivent toujours être capitalisés de manière appropriée.
- Les noms de produits et de marques doivent être capitalisés conformément à leurs directives de marque.
- Les noms de plugins et de thèmes doivent être capitalisés de manière appropriée.
- Lorsque vous faites référence à des éléments de menu, des étiquettes de boutons ou des options de formulaire, capitalisez la première lettre du premier mot - par exemple, « Cliquez sur le bouton Nouveau sujet pour commencer à écrire. »
- Si quelque chose est capitalisé dans l’interface utilisateur pour une bonne raison, utilisez la même capitalisation lorsque vous écrivez de la documentation à ce sujet.
- Les slugs de catégorie et d’URL sont toujours en minuscules.
En cas de doute, utilisez la casse de phrase.
Points
N’utilisez pas de point pour les éléments suivants :
- Infobulles, légendes d’images ou autres éléments d’interface utilisateur comportant une seule phrase
- Étiquettes de boutons
- Éléments de menu
- Éléments de liste n’incluant pas de verbe
Utilisez un point pour les éléments suivants :
- Phrases régulières
- Infobulles, légendes d’images ou autres éléments d’interface utilisateur comportant plus d’une phrase
- Éléments de liste incluant un verbe
- Texte
altd’image
Mise en garde pour les éléments de liste : Si vous écrivez une liste avec des éléments mixtes (c’est-à-dire que certains nécessitent un point et d’autres non), utilisez des points pour tous.
Emphase
Pour mettre l’accent sur des mots, utilisez par défaut des italiques. Vous pouvez également utiliser le gras si vous estimez que cela correspond au contexte.
Guillemets inversés
Utilisez des guillemets inversés (``) pour le code en ligne, les URL d’exemple et les noms de paramètres. Ne les utilisez à aucune autre fin.
Blocs de code
Lorsque vous incluez des blocs de code, spécifiez le langage de codage dans la mesure du possible en l’ajoutant immédiatement après la clôture d’ouverture (les trois guillemets inversés initiaux) - par exemple, ```css.
