wiki:recommandations [Wiki ubuntu-fr]

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.
{{tag>wiki}}

====== 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.

<note important>Voir aussi et surtout :
  * la [[https://www.dokuwiki.org/fr:wiki:syntax|documentation dokuwiki]]
  * la page [[:wiki:participer wiki]]
  * la page [[:wiki:syntaxe]]
  * et les [[:wiki:mini-tutoriels]].
</note>

===== Modèle général =====

N'hésitez pas à utiliser des modèles comme point de départ de votre documentation.

Ils sont là : [[:wiki:participer_wiki#les modèles]].

===== 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 !
  * 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 !
  * 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**.
  * 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..."
  * 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.
  * 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.
  * É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.\\ 
Chacun fait par contre ce qui lui plaît dans les pages de son espace personnel (vous pouvez y tenir un journal de développement si vous le souhaitez).

===== Techniquement =====

  * Consultez la [[https://www.dokuwiki.org/fr:wiki:syntax|documentation dokuwiki]] et utilisez les codes appropriés !
  * ''apt install'' plutôt que ''apt-get install''.
  * Attention à la casse (minuscules / majuscules) de certains noms ou sigles ! Par ex. ne pas confondre ''[[:APT]]'' et ''[[:apt-cli|apt]]''.

<note tip>
Voir aussi [[:utilisateurs:krodelabestiole:brouillons:documentation|comment reconnaître une documentation moisie]] comme exemple de ce qu'il ne faut pas faire.
</note>

==== Mini tutoriels ====

Utilisez les mini tuto, pour l'installation, désinstallation de logiciels depuis tout format, ou de PPA !
C'est là : [[:wiki:mini-tutoriels]].

==== Notes de bas de page ====

<code>((Note de bas de page))</code>
Cette double parenthèse permet de créer une note de bas de page. Elle permet justement de garder la page **claire et simple**, sans partir dans tous les sens. Très utile pour les //voir aussi//, ou les liens vers wikipedia ''%%[[wpfr>%%...'' quand on a déjà mis un lien interne ''%%[[:%%...'' ou vers le site officiel ''%%[[https://%%...]]''.

==== Mise en forme ====

=== Code en ligne ===

Pour tout ce qui est nom de paquet, commande courte ou court extrait de code, nom ou valeur de variable, chemin, etc.
comme ''ça'' :
<code>''truc''</code>
(plutôt que du gras ou de l'italique)

=== Images ===

Attention aux [[https://www.dokuwiki.org/fr:wiki:syntax#images_et_autres_fichiers|images]] : les espace après ''%%{{%%'' ou avant ''%%}}%%'' ont leur importance pour définir l'alignement de l'image !

On veut généralement que les illustrations (captures, schémas, ...) soient alignées à gauche, mais non flottantes, comme le reste du texte. Donc sans espace entre les ''%%{{}}%%'' mais avec un saut de ligne avant et après :

<code>
blabla, voir capture :

{{:chemin:capture.png?400}}

blabla
</code>

Tandis que les icônes des applications peuvent être flottantes sur la droite :
<code>
{{ :chemin:capture.png?80|icône de l'application}}
==== Titre de l'application ====

blabla
</code>

Ici après le ''?'' on a la largeur de l'image en pixels. Et après le ''|'', le contenu de l'attribut ''[[https://developer.mozilla.org/fr/docs/Web/HTML/Element/img#alt|alt]]'', affiché au survol de l'image, indispensable niveau accessibilité !

=== Tableaux ===

C'est la même chose pour les [[https://www.dokuwiki.org/fr:wiki:syntax#tableaux|tableaux]] : attention aux espace avant ou après ''|'' qui déterminent l'alignement du texte !

==== Liens adaptés ====

utilisez des [[https://www.dokuwiki.org/fr:wiki:syntax#liens|liens]] adaptés, voir [[https://www.dokuwiki.org/fr:wiki:syntax#liens|documentation dokuwiki]] !

  * Utilisez des liens internes avec <code>[[:lien]]</code> ou <code>[[:tutoriel:page]]</code>Ce n'est pas indiqué sur la doc officielle mais commencer par '':'' permet de rendre le chemin absolu, donc fonctionnel depuis partout.
  * Pour les articles wikipedia : <code>[[wpfr>article]]</code>
  * Pour l'installation des paquets :<code>''[[apt>paquet]]''</code>
  * <code>[[https://]]</code> est à réserver au forum et aux sites exotiques.

==== Application web ====

Si elle existe évitez de documenter uniquement l'installation via paquet APT qui n'est souvent pas à jour.

Si l'application requiert un serveur [[:lamp]], vous pouvez suivre le modèle de la page [[:WordPress]].

===== Versions =====

On documente en priorité les deux dernières versions LTS.

La documentation spécifique à des versions qui ne sont plus supportées doit être supprimée.

On indique les versions par leur nom de code et leur numéro de version, avec un lien vers la page qui leur est dédiée, par ex. : [[:bionic|Bionic 18.04]].

===== Tags =====

On indique dans les tags les versions LTS concernées par la doc, seulement par leur nom de code.

===== Lignes de commande =====

Il est recommandé d'éviter d'indiquer uniquement la ligne de commande (il vaut mieux apprendre à pêcher...), excepté dans certaines circonstances :
  * restauration de l'affichage graphique (évidemment)
  * documentation d'un outil en ligne de commande (dans ce cas on peut quand-même proposer des alternatives en bas de page)
  * documentation spécifiquement orientée serveur (on utilise généralement SSH, et pas d'interface graphique)
  * pas d'alternative graphique existante

... et en particulier quand elle fait intervenir ''sudo''.

  * Dans tous les cas ne jamais présenter des commandes sans **expliquer** indépendamment ce qu'elles font.

===== Règles typographiques générales =====

Ce sont des règles générales pour l'écriture du français. Il peut y avoir des différences en fonction des pays (pas d'espace avant '':'' en Suisse par ex.).

==== Signes simples ====

  * point ''.''
  * virgule '',''
  * points de suspension ''...'' (3 points ''%%...%%'' sont remplacés par le caractère ''...'' automatiquement)

//Signe simple, espace simple// : on met une espace après le signe, pas avant.

==== Signes doubles ====

  * deux-points '':''
  * point-virgule '';''
  * point d'exclamation ''!''
  * point d'interrogation ''?''

//Signe double, espace double// : une espace avant et une espace après.

==== Autres ====

Parenthèses ''( )'' et guillemets droits ''%%" "%%'' : espaces à l'extérieur, mais pas à l'intérieur.\\
Exception : pas d'espace entre la parenthèse finale et le signe simple qui suit.

Guillemets à l'anglaise ''“ ”'' : comme les guillemets droits.\\
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.

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]]))
(et pas d'espace autour !).