Cette page se propose de compléter le chapitre des bonnes pratiques pour la rédaction de la documentation ici présente, et de partager les décisions prises en particulier sur la mailing list concernant des points particuliers de la ligne éditoriale.
N'hésitez pas à utiliser des modèles comme point de départ de votre documentation.
Ils sont là : les modè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 '').
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).
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.
((Note de bas de page))
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://…]].
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)
Attention aux 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 :
blabla, voir capture :
{{:chemin:capture.png?400}}
blabla
Tandis que les icônes des applications peuvent être flottantes sur la droite :
{{ :chemin:capture.png?80|icône de l'application}}
==== Titre de l'application ====
blabla
Ici après le ? on a la largeur de l'image en pixels. Et après le |, le contenu de l'attribut alt, affiché au survol de l'image, indispensable niveau accessibilité !
C'est la même chose pour les tableaux : attention aux espace avant ou après | qui déterminent l'alignement du texte !
utilisez des liens adaptés, voir documentation dokuwiki !
[[:lien]]
ou
[[:tutoriel:page]]
Ce n'est pas indiqué sur la doc officielle mais commencer par : permet de rendre le chemin absolu, donc fonctionnel depuis partout.
[[wpfr>article]]
''[[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 :
… et en particulier quand elle fait intervenir sudo.