Documentation forgeron en français Duniter v2

Hier avec @joss.rendall nous avons discuté de la documentation utilisateur de Duniter v2. Je lui ai communiqué ma stratégie à l’oral, mais il me paraît important de l’expliciter ici.

D’abord un peu d’historique. On a plusieurs fois tenté de basculer la langue utilisée sur ce forum (Discussions in English? par exemple) mais on est toujours revenu au français. L’idée était qu’un forum technique peut être en anglais car la plupart des devs du monde sont à l’aise dans cette langue, au moins à l’écrit et sur des sujets techniques.

Le forum c’est surtout de l’aide, mais pas vraiment une documentation, et c’est difficile de s’en faire une vision d’ensemble. Je pensais qu’il était important que la documentation utilisateur et les actualités sur le projet soient disponibles en anglais pour un public plutôt technique et donc j’ai concentré mes efforts sur le site duniter.org. C’est donc celle-ci que je mets à jour régulièrement pour refléter les évolutions des logiciels.

Je ne perds pas de vue que quand j’étais débutant, c’est la documentation plus grand public en français qui m’a permis de commencer. Le site a changé depuis mais elle est toujours disponible ici : https://duniter.org/wiki/doc/install/ / https://duniter.org/wiki/doc/commands/.

Avec la constitution du groupe de forgeons dans le cadre le la migration (cf Mise à jour V2 - Forum Monnaie Libre), je pense que c’est le bon moment pour adapter la documentation technique en anglais à destination des forgerons francophones. Il ne s’agit pas vraiment d’une traduction, puisque ça ne vise pas le même public, mais plutôt d’une adaptation. Je propose de procéder ainsi : je copie les fichiers en anglais sur le dépôt en français, et les forgeons les reprennent petit à petit en français et avec des explications plus grand public. Par exemple je n’ai pas expliqué comment configurer une connexion ssh, installer une image debian, ou gérer des docker compose parce que ce n’est pas le niveau de vulgarisation que je visais pour la documentation en anglais, mais c’est pertinent pour la documentation en français.

Si un export en pdf peut aider certaines personnes qui préfèrent les supports paginés, je peux travailler dessus, ça doit pas être trop compliqué. Mais d’abord on peut commencer par le site web, plus adapté aux retours pour amélioration.

J’ai fait un petit tutoriel en anglais sur l’édition du site web, je peux en faire un en français si besoin : Migration du site web duniter.org / traduction en anglais de duniter.fr - #15 by HugoTrentesaux.

4 Likes

J’ai également pu intégrer le projet et avancer dès le début grâce à cette doc.
Je pense, comme @HugoTrentesaux, qu’elle doit être à portée des nouveaux venus et donc être le support de base avec plus de détails de la doc mise en place par la commission forgeron v2.

Celle-ci pourra être complétée par des supports supplémentaires comme des exports PDF, des vidéos explicatives, etc.

@HugoTrentesaux m’a donné un accès pour l’édition du site web, je vais étudier de près son tuto, afin d’obtenir les compétences nécessaires à cette fin.

Nous allons parler collectivement de cette approche en commission forgeron v2 et faire un retour public.

4 Likes