Différences
Ci-dessous, les différences entre deux révisions de la page.
| Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
|
wiki:recommandations [Le 20/03/2025, 14:03] krodelabestiole |
wiki:recommandations [Le 14/04/2025, 11:55] (Version actuelle) krodelabestiole [Ligne éditoriale] reformulations |
||
|---|---|---|---|
| Ligne 20: | Ligne 20: | ||
| ===== Ligne éditoriale ===== | ===== Ligne éditoriale ===== | ||
| - | * Évitez le **prosélytisme** ! pas de "//embellissez votre vie grâce à systemd...//". Si un logiciel est bon, sa simple description factuelle suffira à motiver son adoption. Assez de pub autour de nous, faites confiance à l'intelligence des lecteurs ! | + | * É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** : mettez un lien vers la page ou le chapitre le plus adapté, où sera le mieux détaillé ce dont vous avez besoin ! Ça facilite la maintenance et donne accès à un maximum d'infos. | + | * 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]].)) |
| * Ne soyez pas avare en **liens internes**, c'est très utile pour apprendre le vocabulaire et comprendre l'articulation de l'informatique ! | * Ne soyez pas avare en **liens internes**, c'est très utile pour apprendre le vocabulaire et comprendre l'articulation de l'informatique ! | ||
| * Allez droit au but, pas de remplissage pour le remplissage ou de répétition. Il faut inviter au maximum à la lecture, et ça se fait souvent en restant **concis**. | * Allez droit au but, pas de remplissage pour le remplissage ou de répétition. Il faut inviter au maximum à la lecture, et ça se fait souvent en restant **concis**. | ||
| Ligne 29: | Ligne 29: | ||
| * Sur le web, **souligné** veut dire : 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'//emphase//). Le **gras** sert à faire ressortir le sujet d'un paragraphe, comme ici (en remplaçant par ex. un sous-titre), ou éventuellement pour des noms de logiciels (pour les noms de paquets, mieux vaut utiliser ''%%''%%''). | * Sur le web, **souligné** veut dire : 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'//emphase//). Le **gras** sert à faire ressortir le sujet d'un paragraphe, comme ici (en remplaçant par ex. un sous-titre), ou éventuellement pour des noms de logiciels (pour les noms de paquets, mieux vaut utiliser ''%%''%%''). | ||
| * Ne documentez pas un logiciel que vous ne maîtrisez pas ou mal. On trouve beaucoup d'erreurs ou de mauvaises méthodes sur le web, mieux vaut parfois ne rien faire que de les relayer. | * Ne documentez pas un logiciel que vous ne maîtrisez pas ou mal. On trouve beaucoup d'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, ce n'est pas le code de ces outils, ce n'est pas une forge logiciel et ce n'est pas un outil 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, framagit, launchpad...) et postez un lien vers votre outil sur le wiki. | ||
| Ces recommandations valent pour les pages de documentation ordinaires.\\ | Ces recommandations valent pour les pages de documentation ordinaires.\\ | ||