| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente |
| wiki:recommandations [Le 03/09/2026, 17:06] – suppr doublon casse | réorganisation (modèles avec mini tutos) krodelabestiole | wiki:recommandations [Le 14/09/2026, 05:54] (Version actuelle) – détail : l'italique peut remplace les guillemets krodelabestiole |
|---|
| ====== Recommandations concernant le Wiki ubuntu-fr ====== | ====== Recommandations concernant le Wiki ubuntu-fr ====== |
| |
| Cette page se propose de compléter le chapitre des [[:wiki:participer_wiki#bonnes pratiques]] pour la rédaction de la documentation ici présente, et de partager les décisions prises en particulier sur la [[:wiki:liste_discussion|mailing list]] concernant des points particuliers de la ligne éditoriale. | Cette page se propose de compléter le chapitre des [[:wiki:participer_wiki#bonnes pratiques]] pour la rédaction de la documentation ici présente, et de partager les décisions prises en particulier sur la [[:wiki:liste_discussion|mailing list]], du temps de son existence, concernant des points particuliers de la ligne éditoriale. |
| |
| <note important>Voir aussi et surtout : | <note important>Voir aussi et surtout : |
| * É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 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]] ! |
| * 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// ou 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 utilisateurs à 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 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). |
| * 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 un logiciel 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, 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** (gittea, gitlab, [[https://framagit.org/|framagit]], launchpad...) et postez seulement le lien vers votre outil et éventuellement sa documentation sur le wiki. |
| |
| <note> | <note> |
| * //Répertoire// plutôt que //dossier// (plutôt propres à Windows et macOS). | * //Répertoire// plutôt que //dossier// (plutôt propres à Windows et macOS). |
| * //Support de stockage// plutôt que //disque//, maintenant que les [[:SSD]] existent (et n'ont pas de disque). | * //Support de stockage// plutôt que //disque//, maintenant que les [[:SSD]] existent (et n'ont pas de disque). |
| * //Sur// Ubuntu, //sur// Internet, ou //sur// un support plutôt que //dans//. | * //Sur// Ubuntu, //sur// Internet, ou //sur// un support plutôt que //dans// (aussi, //Internet// n'est pas une source). |
| * Attention à la graphie -- accents, espaces, traits d'union, underscores -- et à la [[wpfr>Casse_(typographie)|casse]] -- majuscules / minuscules -- des noms d'applications et de protocoles ! Par ex. ne pas confondre ''[[:APT]]'' et ''[[:apt-cli|apt]]''. | * Attention à la graphie -- accents, espaces, traits d'union, underscores -- et à la [[wpfr>Casse_(typographie)|casse]] -- majuscules / minuscules -- des noms d'applications et de protocoles ! Par ex. ne pas confondre ''[[:APT]]'' et ''[[:apt-cli|apt]]''. |
| | * Plutôt qu'utiliser le terme //lien//, en choisir un qui explique de quoi il s'agit (//ressources externes// faute de mieux). |
| |
| ===== Règles typographiques générales ===== | ===== Règles typographiques générales ===== |
| Guillemets à l'anglaise ''“ ”'' : comme les guillemets droits.\\ | Guillemets à l'anglaise ''“ ”'' : comme les guillemets droits.\\ |
| Guillemets à la française ''« »'' : comme les signes doubles.\\ | Guillemets à la française ''« »'' : comme les signes doubles.\\ |
| Ces signes sont plutôt littéraires et alourdissent les pages de ce wiki inutilement, on peut généralement se contenter des guillemets droits. | Ces signes sont plutôt littéraires et alourdissent les pages de ce wiki inutilement, on peut généralement se contenter des guillemets droits, voire le plus souvent de l'italique. |
| |
| Pareil pour les apostrophes : inutile d'utiliser les apostrophes littéraires ''’'', le guillemet simple ''%%'%%'' (aussi appelé apostrophe droite) va très bien et prend moins de place !((cf [[wpfr>Guillemet#Codage]])) | Pareil pour les apostrophes : inutile d'utiliser les apostrophes littéraires ''’'', le guillemet simple ''%%'%%'' (aussi appelé apostrophe droite) va très bien et prend moins de place !((cf [[wpfr>Guillemet#Codage]])) |
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