> 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.
• Si les termes anglais sont à mettre en italique, pas les abbréviations anglaises qui restent en police normale

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
• MTU est féminin.

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:

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é.
Il est donc plus intéressant d'utiliser le module de référence Reflist qui est construit sur le module Cite.

Dans le texte encadrer la référence par

<ref> ma ref</ref>

Ensuite, la liste des réferences est crée dans une page wiki par l'instruction

<references />

Une réference est sur le style: Auteur, Prénom. (Année). Editeur. Titre.

Par exemple:

<ref>Huston, G (2013). APNIC Labs. [http://labs.apnic.net/?p=335 A Primer on IPv4, IPv6 and Transition]</ref>
 

donnera^[1]

References

1. ↑ Huston, G (2013). APNIC Labs. A Primer on IPv4, IPv6 and Transition