Rédiger une documentation efficace pour Discourse

Salut Simon ! :blob_wave:

J’allais voir comment cela se passerait, mais oui, je suis pareil, j’essaie d’éviter les contractions.

Hahaha, ouais… Je n’utiliserai aucun de ces mots dans la documentation, de peur de révéler mon :face_with_monocle:.

Absolument : Example Domains

C’est le point que je suis venu discuter ici ! :smiley:

Nous avons eu beaucoup d’échanges à ce sujet, et j’ai été ravi de voir cela inclus dans le guide de style par défaut.

Voici pourquoi je pense que c’est important : la production de documentation doit être accessible au plus grand nombre de membres de notre communauté que possible, y compris (surtout ?) nos membres de l’équipe Discourse.

Discourse est un logiciel de discussion sociale. Et une partie de la documentation est vraiment une conversation continue. Si je partage une pratique sur la façon dont j’intègre les membres dans ma communauté, je voudrais être présenté comme le « propriétaire » de ce sujet, afin de pouvoir répondre aux questions et développer le sujet.

D’un autre côté, si un client pose une question sur une fonctionnalité que nous n’avons jamais expliquée, j’aimerais pouvoir utiliser le guide de style et produire une documentation utile et générale, ce que je pense que le fait d’être le propriétaire du sujet rend plus difficile à publier.

De plus, si nous produisons de la documentation en dehors de Discourse (une intégration ou une production à partir de commentaires de code ou autre), avoir un « utilisateur de documentation » est probablement plus facile en tant que détail d’implémentation. :thinking:

Je ne pense pas que ce guide empêchera les gens d’injecter leur voix et leur personnalité, et d’héberger la discussion. Mais ce serait formidable si cela aidait plus de gens à prendre l’habitude de documenter, qui autrement ne le feraient pas (et nous pourrons alors les encourager à être plus personnels !) :smiley:

3 « J'aime »