Je me permets de rajouter mes 2cs de non-initié au projet à la discussion sur le README.
Si celui contient énormément d'informations (gros +1 pour ça, c'est ultra agréable), j'ai personnellement ressenti un manque de structure au bout d'un moment.

Renforcer la structure ce document permettrait d'avoir

• un meilleur aperçu des ressources et outils utilisés, ce qui permet une gestion plus efficace dans le temps.
• d'abaisser la barrière d'entrée (enfin vu là où elle est on va dire la supprimer même) ce qui facilitera sans doute le travail lors d'initiatives comme celles proposés dans Traduire de la documentation à l'école #986.

Par exemple : de nombreux outils sont évoqués à différents endroits du document (powrap est mentionné au début au milieu des commandes Git, puis on en retrouve après le glossaire) sans que l'on sache nécessairement quels sont leurs intérêts respectifs.
Il serait également intéressant de mentionner pogrep (but de l'issue) ainsi que padpo qui sont utilisés en pratique, mais pas mentionnés.

Le partie sur la touche de composition et les caractères spéciaux occupe une grosse partie du document. Cette partie pourrait être réduite en 1) expliquant d'abord la touche de composition et comment la définir puis 2) mentionner les caractères propres au français. Comme la touche de composition est déjà évoqué en premier lieu, la deuxième partie prendrait beaucoup moins de place.

Peut-être qu'il pourrait être intéressant de créer un fichier CONTRIBUTION.md qui reprend les éléments propres à la contribution et garder dans le README.md uniquement les informations génériques. Soit la répartition qui se rapprocherait de :

README.md :

• Historique du projet
• Guide sur comment contribuer (quelques informations génériques puis lien vers CONTRIBUTION.md)
• Accord de contribution à la documentation

CONTRIBUTION.md

• Contribuer en utilisant Github : pas à pas
• Que traduire
• Les outils utiles pour traduire (les indispensables, les moins indispensables)
• Saisir du français valide : touche de composition
  • Les caractères auxquels il faut prêter attention.
• Ressources utiles
• Glossaire

Un truc dans ces eaux là quoi.

Il serait également intéressant de mentionner pogrep (but de l'issue) ainsi que padpo qui sont utilisés en pratique, mais pas mentionnés.

Dans la pratique, j'ai créé padpo il y a une ou deux semaines 😉 donc effectivement il n'est pas mentionné dans le README, on est en train de l'éprouver !

Par contre, je suis assez d'accord avec toi sur la complexité du README. Je n'arrive pas à retrouver un commentaire, que j'avais écrit, et qui proposait comme toi d'avoir un README plus simple, accompagné d'un autre document avec les détails pour chaque partie du README.

Typiquement, pour la proposition #986, je vais créer un diaporama pour mettre les étudiants sur la voie, ce diaporama étant ma vision d'un README simple. La version détaillée sera l'actuel README accompagné d’interactions orales.

Le partie sur la touche de composition

C'est peut-être le moment de passer tout le monde au clavier bépo 😛 (ceci dit, ça fait une dizaine d'années que je n'utilise plus que le clavier bépo et j'adore… https://bepo.fr)

Excellente suggestion. +1 sur l'absence de structure du README. +1 sur la partie sur les touches de compositions qui est trop grosse, avec trop d'espacement, en plein milieu du README, même avant le glossaire, coupant le README en deux.
On a aussi un wiki avec Github qu'on peut activer. Après je remarque que les projets l'utilisent quasiment jamais, il y a peut être une raison.

@Kydlaw Est-ce que tu te sens de prendre le sujet :) ? Et vu que c'est une remarque pertinente, est-ce que tu pourrais faire de ton commentaire une issue en propre stp :) ?

Dans la pratique, j'ai créé padpo il y a une ou deux semaines wink donc effectivement il n'est pas mentionné dans le README, on est en train de l'éprouver !

Ok je comprends. Je vais le tester sur ma PR et je te ferais un retour s'il y a besoin.

On a aussi un wiki avec Github qu'on peut activer. Après je remarque que les projets l'utilisent quasiment jamais, il y a peut être une raison.

Peut-être overkill pour la plupart des projets ? Je pense qu'une première version avec 2 fichiers permettront de se faire une idée et de voir si c'est ça peut valoir le coup.
`

@Kydlaw Est-ce que tu te sens de prendre le sujet :) ?

Je peux m'en occuper, je pense pouvoir le faire ce week-end.

Et vu que c'est une remarque pertinente, est-ce que tu pourrais faire de ton commentaire une issue en propre stp :) ?

Je pensais la même chose. Je copie mon commentaire et le contexte dans une autre issue. On fera le ménage après (voir fermer cette issue?).

Je supprimerai les commentaires qui ne sont pas liés à cette issue (et pas la fermer parce qu'elle reste à réaliser). Et j'invite @vpoulailleau à recopier son premier commentaire dans l'issue que tu créeras ;)