Y’a une chose que j’essaie de faire lorsque je produis de la documentation logicielle, c’est d’éviter le jargon inutile et globalement de respecter les principe du français facile à lire et à comprendre
J’essaie aussi de rendre le texte attrayant, parce que bordel faut arrêter de faire de la docu fade et monotone :baduk:
Ch’sais pas, rajoutez des petites phrases drôles ou mignonnes, des emojis, de l’empathie, surtout au début du texte et aux endroits un peu plus complexes
Vous pouvez voir un exemple dans ma documentation de mon package de AdGuard Home
Aussi, faut pas hésiter à expliquer des trucs habituellement jugés comme trivial, parce que les habitués peuvent juste sauter ces passages alors que les néophytes vous seront vraiment reconnaissants !
Par exemple dans cette autre documentation du même package j’ai mis toutes les étapes pas à pas alors que c’est vraisemblablement pas strictement nécessaire
Mais je pense que moins une documentation est implicite, meilleurs elle est
(Notez que je n’ai pas rédigé la partie concernant Android donc je ne saurais la juger)
Voilà c’était mes humbles 2 centimes sur comment j’essaie de faire de la meilleure documentation à mon petit niveau :blabcat:
⎎ mégane ⎚ artéfactrice ⎃
@oniricorpe@gts.oniricorpe.eu
