From 299ffdc1ceff0a47fa25cb402a74179c515db316 Mon Sep 17 00:00:00 2001 From: gcolpart Date: Sat, 28 Apr 2018 21:07:51 +0200 Subject: [PATCH] ajout de la convention des arguments longs --- Syntaxe.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Syntaxe.md b/Syntaxe.md index d525f2f3..ba58d55f 100644 --- a/Syntaxe.md +++ b/Syntaxe.md @@ -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]()