Revision as of 11:17, 7 September 2015

> MOOC>Gestion de projet > Guide de rédaction

Structure de chaque chapitre du document compagnon

• Une introduction
• Une conclusion
• Pour aller plus loin

Mise en forme

• Pas de lien vers d'autres pages du wiki
• Inutile de mettre un lien sur un RFC, c'est fait automatiquement par le wiki avec la syntaxe :: RFC xxxx
• les adresses, champs d'en-tête, sont à mettre en police courrier (balise HTML tt )
• Le figures sont à numéroter. Le titre de la figure est à mettre dans le texte sous la figure. Enfin chaque figure doit être citée dans le texte.

Terminologie

• Noeud: Machine ou système connecté (routeur et Hôte). Utiliser à la place de machine
• Hôte : système d'extrémité
• Routeur: système relais
• Internet v4: Internet en IPv4
• Internet v6: Internet en IPv6

Erreurs communes

• entête => en-tête (nom masculin !)
• relais est un mot invariable (s au singulier comme au pluriel)
• interface => nom féminin
• IPv4/IPv6 => le v en minuscule
• Internet avec un grand I pour le réseau

Anglais / Français

• donner le terme français et la traduction anglaise entre parenthèses et italique
  • ex: Le message ICMPv6 d'annonce de voisin (Neighbor Advertisment)
• Lorsqu'il y a une abbréviation donner l'abbréviation puis la signification entre parenthèses et italique
  • ex: PI (Provider Iindependent).
• RFC est masculin
• Implémentation => mise en oeuvre
• Terminologie
  • Solicited Multicast Address : Adresse multicast de sollicitation de voisin

Références:

(Encore à valider)

Avec le mécanisme de génération semi-auto du document compagnon, les références sous forme d'URL apparaissent sous la forme '[x]' sans que l'ont ait la liste correspondante de ces références en fin d'activivté.
Pour la séquence 1, les références apparaissent soit sous forme de titre, soit avec le texte de l'URL (certes cela alourdit le texte, mais la référence apparaît clairement dans le doc compagnon).
Dans la syntaxe du wiki plutot que que mettre uniquement l'URL entre crochet [1], il faut ajouter soit le titre du document IPv6 ou l'échec du marché, soit l'URL lui-même une seconde fois pour qu'elle apparaisse en claire dans la document compagnon http://www.bortzmeyer.org/ipv6-et-l-echec-du-marche.html.
Cette manière de faire n'est pas orthodoxe, relativement aux habitudes d'écriture des articles, cependant en l'état actuel, elle rend le doc compagnon plus lisible.

Ou le module de référence Reflist https://www.mediawiki.org/wiki/Template:Reflist