Ceci est une ancienne révision du document !
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.
Modèle général
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 documentations.
Installation de logiciel
APT
Ajout PPA
Ajouter un PPA est dangereux. Ne documentez jamais add-apt-repository directement sur la page, mais préférez un lien vers ajout_d_un_ppa_a_vos_sources_logicielles qui affiche les avertissements de rigueur.
snap
AppImage
FlatPak
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.
autre
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ées.
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.
Tags
On indique dans 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 que d'offrir un poisson), 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