Style de rédaction des documentations techniques

• Les documentations sont rédigées dans la syntaxe DokuWiki.
• Les entrées sont dans l'ordre chronologique.
• Les titres de deuxième niveau indiquent qui et la date (format ISO). Exemple : ===== Auteur 2018-04-04 =====
• Les titres de troisième niveau indiquent la nature du travail effectué. Exemple : ==== Description des usages de rédaction ====
• Les titres de niveau 4 === exemple === et 5 == dernier exemple == servent aux découpages internes.
• Le nommage des pages se fait de la façon suivante (exemple pour Debian mais identique pour des ports FreeBSD)
  • Si travail sur un paquet « logiciel » sur le serveur Machine, la page décrivant ces travaux s'appellera logiciel_machine
    • S'il y a plusieurs configurations indépendantes utilisant le même logiciel, ajouter l'information spécifique au milieu. Exemples :
      • nginx_supervision.proxience.org_machine : site « supervision.proxience.org » sur Machine.
      • nginx_supervision.proxience.fr_machine : site « supervision.proxience.fr » sur Machine.
  • Si travail d'administration globale sur une machine (non lié à un paquet), la page commencera par machine. Exemples :
    • machine_mise_a_niveau_stretch-buster pour la documentation du passage de Debian 9 vers Debian 10.
    • machine_stretch_gestion, travaux généraux en Stretch
    • machine_buster_gestion, travaux généraux en Buster

Les machines virtuelles et les cachots sont nommés. Par exemple « essai » ou « prototype » sur la machine Machine. Les règles ci-dessus s'appliquent en indiquant essai.machine ou prototype.machine à la place de machine.

• https://wiki.debian.org/fr/TextEditor en privilégiant ceux qui ont la coloration syntaxique.