18
0
Fork 0

ajout de la convention des arguments longs

This commit is contained in:
gcolpart 2018-04-28 21:07:51 +02:00
parent 945ef2c84f
commit 299ffdc1ce
1 changed files with 2 additions and 1 deletions

View File

@ -127,8 +127,9 @@ Par défaut on considère que l'on écrit de la documentation pour la version *s
* Les conventions de syntaxe doivent être appliquées partout (voir ci-dessous) notamment pour les adresses IP, les "Note :", les fichiers sous la forme `/etc/foo.conf` etc.
* Les exemples de code ou contenu de fichiers doivent utiliser la syntaxe avec trois tildes
* Si l'on mentionne des autres documentations, mettre des liens internes
* Objectif 0 faute d'orthographe
* Objectif 0 faute d'orthographe / de grammaire
* Tout ce qu'on a mis en production sur des serveurs doit être mentionné
* Quand on mentionne des commandes avec des arguments, il faut mettre les versions longues (exemple: `--dry-run` au lieu de `-d` si possible)
* Si la doc est longue, on hésitera pas à avoir un titre "Configuration de base" et "Configuration avancée", ou alors un sous-titre "Utilisation de base" avec les commandes de base si l'on doit lire la doc en 1 minute
* Si la doc est très longue, elle peut être découpée en sous-pages à l'exemple du [HowtoMySQL]()