| Les deux révisions précédentesRévision précédente | |
| wiki:recommandations [Le 14/09/2026, 05:54] – détail : l'italique peut remplace les guillemets krodelabestiole | wiki:recommandations [Le 24/10/2026, 23:01] (Version actuelle) – [Ligne éditoriale] typos | liens internes krodelabestiole |
|---|
| ===== Ligne éditoriale ===== | ===== Ligne éditoriale ===== |
| |
| * Évitez le **prosélytisme** ! pas de "//embellissez votre vie grâce à systemd...//". Si un logiciel est utile et bon, sa simple description factuelle suffit à motiver son adoption. Assez de pub autour de nous, faites confiance à l'intelligence et au jugement des lecteur·rice·s ! | * Évitez le **prosélytisme**\_! pas de "//embellissez votre vie grâce à systemd...//". Si un logiciel est utile et bon, sa simple description factuelle suffit à motiver son adoption. Assez de pub autour de nous, faites confiance à l'intelligence et au jugement des lecteur·rice·s\_! |
| * Pas de **doublon** (ou pire) : si il existe une page ou un chapitre plus appropriée détaillant déjà votre sujet, il est beaucoup plus judicieux de les mettre en lien que de se répéter, même succinctement ! Ça donne accès aux internautes à un maximum d'infos et pour les contributeurs c'est le seul moyen de rendre possible la maintenance globale du wiki.((C'est en particulier le cas pour les procédures répétitives et systématiques, voir [[:wiki:mini-tutoriels|mini-tutos]].)) | * Pas de **doublon** (ou pire) : si il existe une page ou un chapitre plus appropriée détaillant déjà votre sujet, il est beaucoup plus judicieux de les mettre en lien que de se répéter, même succinctement\_! Ça donne accès aux internautes à un maximum d'infos et pour les contributeurs c'est le seul moyen de rendre possible la maintenance globale du wiki.((C'est en particulier le cas pour les procédures répétitives et systématiques, voir [[:wiki:mini-tutoriels|mini-tutos]].)) |
| * N'utilisez **pas la première personne**, ni pour parler de votre expérience personnelle (le wiki n'est pas un journal personnel), ni pour déposséder le lecteur de son identité ! | * N'utilisez **pas la première personne**, ni pour parler de votre expérience personnelle (le wiki n'est pas un journal personnel), ni pour déposséder le lecteur de son identité\_! |
| * Si votre avis ou votre méthode ne fait pas **consensus**, prenez-le en compte en l'indiquant par ex. par "//selon certains avis...//" | * Si votre avis ou votre méthode ne fait pas **consensus**, prenez-le en compte en l'indiquant par ex. par "//selon certains avis...//". |
| * Évitez de parler de la documentation sur la documentation : si celle-ci n'est pas à jour, dans la mesure du possible mettez-la à jour plutôt que de **rayer le texte** (le bouton a été [[https://forum.ubuntu-fr.org/viewtopic.php?pid=22906523#p22906523|volontairement désactivé]]) ou d'écrire que "//les infos ne sont pas à jour//", svp ! C'est toujours mieux que rien, mais aucun autre contributeur ou administrateur ne devrait être censé passer derrière ce que chacun écrit. On peut utiliser ''%%FIXME%%'' (FIXME) surtout si on pense passer plus tard derrière, ou si on sait que l'information est fausse mais qu'on n'a pas les compétences qui permette la correction -- dans ce cas ne pas hésiter à demander de l'aide sur [[https://forum.ubuntu-fr.org/viewforum.php?id=208|le forum]] ! | * Évitez de parler de la documentation sur la documentation : si celle-ci n'est pas à jour, dans la mesure du possible mettez-la à jour plutôt que de **rayer le texte** (le bouton a été [[https://forum.ubuntu-fr.org/viewtopic.php?pid=22906523#p22906523|volontairement désactivé]]) ou d'écrire que "//les infos ne sont pas à jour//", svp\_! C'est toujours mieux que rien, mais aucun autre contributeur ou administrateur ne devrait être censé passer derrière ce que chacun écrit. On peut utiliser ''%%FIXME%%'' (FIXME) surtout si on pense passer plus tard derrière, ou si on sait que l'information est fausse mais qu'on n'a pas les compétences qui permettent la correction -- dans ce cas ne pas hésiter à demander de l'aide sur [[https://forum.ubuntu-fr.org/viewforum.php?id=208|le forum]]\_! |
| * Ne soyez pas avare en **[[:wiki:syntaxe#internes|liens internes]]**, c'est très utile pour apprendre le vocabulaire, accéder facilement à davantage d'informations, et comprendre l'articulation de l'informatique ! | * Ne soyez pas avare en **[[:wiki:syntaxe#internes|liens internes]]**, c'est très utile pour apprendre le vocabulaire, accéder facilement à davantage d'informations, et comprendre l'articulation de l'informatique\_! |
| * Allez droit au but, pas de remplissage pour le remplissage, de hors-sujet ou de répétition (cf. point //doublon// au dessus). Il faut inviter autant que possible à la lecture, et ça se fait souvent en restant **concis**. | * Allez droit au but, pas de remplissage pour le remplissage, de hors-sujet ou de répétition (cf. point //doublon// au dessus). Il faut inviter autant que possible à la lecture, et ça se fait souvent en restant **concis**. |
| * Expliquez les lignes de commande ! Plutôt que :\\ //Entrer la commande ://\\ utilisez par exemple :\\ //Autoriser l'accès en écriture avec la commande ''[[man>chmod]]'' ://\\ Sans quoi les lignes de commande risquent d'être perçues comme des formules magiques, et n'aident pas les utilisateurs à gagner en autonomie. | * Expliquez les lignes de commande\_! Plutôt que\_:\\ //Entrer la commande\_://\\ utilisez par exemple\_:\\ //Autoriser l'accès en écriture avec la commande ''[[man>chmod]]''\_://\\ Sans quoi les lignes de commande risquent d'être perçues comme des formules magiques, et n'aident pas les utilisateur·ice·s à gagner en autonomie. |
| * Quand ils ne sont pas strictement nécessaires, évitez de coller les retours de commande en exemple qui donnent à voir un système particulier, qui ne correspond pas à celui du lecteur, ou qui sont trop techniques pour être utiles (les informaticiens utilisent en priorité la documentation officielle de chaque logiciel). | * Quand ils ne sont pas strictement nécessaires, évitez de coller les retours de commandes en exemple qui donnent à voir un système particulier, qui ne correspond pas à celui du lecteur, ou qui sont trop techniques pour être utiles (les informaticiens utilisent en priorité la documentation officielle de chaque logiciel). |
| * Sur le web, **souligné** veut dire : __[[wpfr>Hyperlien|lien]]__. À éviter pour faire ressortir du texte qui n'en est pas un donc ! Pour mettre du texte en valeur utilisez plutôt les ''<note>'' si il est long, sinon l'italique (on parle d'//[[wpfr>Emphase_(typographie)|emphase]]//). Le **gras** sert à faire ressortir le sujet d'un paragraphe, comme ici (en ayant un peu le rôle d'un sous-titre), ou éventuellement pour des noms de logiciels ou de protocoles (pour les chemins, les noms de paquets ou les commandes, mieux vaut utiliser ''%%''%%''). En fait mieux vaut ne jamais utiliser le bouton //Soulignage// (le bouton a été [[https://forum.ubuntu-fr.org/viewtopic.php?pid=22906523#p22906523|volontairement désactivé]]).((Voir //[[https://www.mediacom87.fr/souligne-vous-n-y-songez-pas/|Souligné, vous n'y songez pas]]//)) | * Sur le web, **souligné** veut dire : __[[wpfr>Hyperlien|lien]]__. À éviter pour faire ressortir du texte qui n'en est pas un, donc\_! Pour mettre du texte en valeur utilisez plutôt les ''<note>'' si il est long, sinon l'italique (on parle d'//[[wpfr>Emphase_(typographie)|emphase]]//). Le **gras** sert à faire ressortir le sujet d'un paragraphe, comme ici (en ayant un peu le rôle d'un sous-titre), ou éventuellement pour des noms de logiciels ou de protocoles (pour les chemins, les noms de paquets ou les commandes, mieux vaut utiliser ''%%''%%''). En fait mieux vaut ne jamais utiliser le bouton //Soulignage// (le bouton a été [[https://forum.ubuntu-fr.org/viewtopic.php?pid=22906523#p22906523|volontairement désactivé]]).((Voir //[[https://www.mediacom87.fr/souligne-vous-n-y-songez-pas/|Souligné, vous n'y songez pas]]//)) |
| * Ne documentez pas une technique ou une application que vous ne maîtrisez pas, ou mal. On trouve beaucoup d'[[:utilisateurs:krodelabestiole:documentation|erreurs ou de mauvaises méthodes]] sur le web, mieux vaut parfois ne rien faire que de les relayer. | * Ne documentez pas une technique ou une application que vous ne maîtrisez pas, ou mal. On trouve beaucoup d'[[:utilisateurs:krodelabestiole:documentation|erreurs ou de mauvaises méthodes]] sur le web, mieux vaut parfois ne rien faire que de les relayer. |
| * Évitez d'inclure des **scripts** sur les pages ! Le wiki est une documentation, sur comment utiliser des outils, il ne propose pas le code de ces outils. Ce n'est pas une forge logiciel, il n'est pas adapté à la révision par les pairs et la maintenance du code. Si vous avez du code à partager, utile pour Ubuntu, partagez-le sur une **forge** (gittea, gitlab, [[https://framagit.org/|framagit]], launchpad...) et postez seulement le lien vers votre outil et éventuellement sa documentation sur le wiki. | * Évitez d'inclure des **scripts** sur les pages ! Le wiki est une documentation, sur comment utiliser des outils, il ne propose pas le code de ces outils. Ce n'est pas une forge logiciel, il n'est pas adapté à la révision par les pairs et la maintenance du code. Si vous avez du code à partager, utile pour Ubuntu, partagez-le sur une **forge** ([[:git#principaux_depots_git|Gitea, Forgejo, GitLab,]] [[https://framagit.org/|FramaGit]], [[:Launchpad]], ...) et postez seulement le lien vers votre outil et éventuellement sa documentation sur le wiki. |
| |
| <note> | <note> |
Sauf mention contraire, le contenu de ce wiki est placé sous les termes de la licence suivante : CC Attribution-Noncommercial-Share Alike 4.0 International