Rédiger une documentation efficace pour Discourse

Jusqu’à ce que nous ayons un moyen natif de gérer les documents localisés, je pense que préfixer le titre avec des drapeaux est le moyen le plus pratique de le faire, et une exception raisonnable à cette directive.

Je pense que ce genre de chose suscite des opinions et des préférences différentes, mais pour ce guide de style, nous nous en tenons aux normes industrielles acceptées. Encore une fois, les directives de Google et de Microsoft s’accordent toutes deux sur le fait qu’il est préférable d’utiliser des contractions courantes.

Cela dit, j’ai lu certains articles suggérant que l’utilisation de contractions négatives (comme “can’t”) pourrait rendre la compréhension plus difficile pour les non-anglophones. Nous allons examiner cela plus en détail et, si nécessaire, mettre à jour le guide de style en conséquence.

J’ai supprimé cet exemple ! :smile:

Oui, c’est très courant (pas seulement sur Discourse), mais je suis d’accord que ce n’est pas tout à fait correct. L’utilisation de guillemets serait préférable, je pense donc que je vais le préciser dans le guide de style.

C’est un excellent point - je vais l’ajouter au guide de style !

Merci pour ce retour ! @maiki a fait de bons commentaires ci-dessus, et je suis d’accord avec ce qu’il dit là. Pour ajouter à cela, je dirai que l’une des raisons pour lesquelles nous avons fait passer les documents officiels à @Discourse comme auteur est de leur donner un plus grand sentiment d’autorité pour les lecteurs, en particulier pour les personnes qui découvrent la documentation pour la première fois. C’est aussi l’impulsion derrière tout le guide de style en premier lieu.

Toute personne rédigeant de la documentation peut tout à fait injecter sa personnalité dans son écriture, et la discussion sur les sujets de documentation individuels ne disparaît pas, c’est donc toujours un bon endroit pour rendre les choses plus personnelles.

Tous ces commentaires sont grandement appréciés :slight_smile:

2 « J'aime »