Recommandations concernant le Wiki ubuntu-fr

Cette page se propose de recenser différents modèles de page, et de partager les décisions prises en particulier sur la mailing list concernant des points particuliers de la ligne éditoriale.

Roschan propose un très bon modèle pour documenter une nouvelle application sur sa page brouillon.

N'hésitez pas à l'utiliser comme point de départ de votre documentation.

Afin de garantir l'homogénéité du wiki, essayez, pour chaque page créée ou éditée, de conformer si possible vos contributions à l'un des modèles proposés :

• pour parler d'un logiciel, le modèle Application ;
• pour présenter un ordinateur, le modèle Portable ;
• pour présenter un périphérique, le modèle Matériel ;
• pour des explications pas à pas, le modèle Tutoriel ;
• pour lister les ressources en lien avec une thématique, le modèle Portail ;
• pour vous présenter sur le wiki, le modèle Utilisateur.

Si la page que vous projetez ne cadre pas avec l'un des modèles proposés, il vaut mieux poser la question aux autres contributeurs que de se lancer dans une adaptation libre, surtout pour une première contribution.

• é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, faite confiance à l'intelligence des lecteurs !
• 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.
• ne soyez pas économe en liens internes, c'est très utile !
• 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 personnel (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. 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).

• Consultez la documentation dokuwiki et utilisez les codes appropriés !
• apt install plutôt que apt-get install

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

Pour tout ce qui est nom de paquet, commande courte ou court extrait de code, nom ou valeur de variable, chemin, etc. comme ça :

''truc''

(plutôt que du gras ou de l'italique)

utilisez des liens adaptés, voir documentation dokuwiki !

• utilisez des liens internes avec

  [[:lien]]

  ou

  [[:tutoriel:page]]

• pour les articles wikipedia :

  [[wpfr>article]]

• pour l'installation des paquets :

  [[apt>paquet]]

• [[https://]]

  est à réserver au forum et aux sites exotiques.

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.

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

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

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 spécifiquement orientée serveur (on utilise généralement SSH, et pas d'affiche graphique)
• pas d'alternative graphique existante

et en particulier quand elle fait intervenir sudo.