Latest revision as of 10:25, 4 March 2022

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

Structure

Chaque activité du document compagnon doit avoir:

1. Une introduction: pour présenter la problématique
2. Une conclusion: pour rappeler les points importants à retenir de l'activité
3. Une référence bibliographique: les citations dans le texte
4. Pour aller plus loin: la liste des RFC citées dans le texte

Terminologie

• Noeud: Machine ou système connecté (routeur et Hôte). Utiliser à la place de machine, équipement
• Hôte ou station : système d'extrémité. Ne pas utiliser le terme de poste, terminal etc.
• Routeur: système relais
• Internet v4: Internet en IPv4
• Internet v6: Internet en IPv6
• Solicited Multicast Address : Adresse multicast de sollicitation de voisin

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. Ceci se déclare de la manière suivante:

<center>
[[Image:42-fig1.jpg|400px|center|thumb|Figure 2: Plan de migration vers IPv6.
]]
</center>

• Uniquement les termes anglais sont à mettre en italique, pas les abréviations anglaises qui restent en police normale. L'abréviation précède le terme entre parenthèses:

TCP (''Transmission Control Protocol'')

• Les RFC mis dans la section pour aller plus loin sont cité dans le texte soient par [RFC XXXX] ou par Reflist
• Pour ajouter un encadré dans le texte. L'encadré sert à apporter des précisions ou à donner des informations générales. Le template est définit sous ce lien Template

{{HorsTexte| Titre|texte.}}

• Les commentaires de relecteur sont à mettre avec la commande note:

{{Note|nom| commentaire}}

• Pour ajouter un texte A faire en rouge

{{TODO|chose à faire}}

Erreurs communes

• entête => en-tête (nom masculin !)
• Ce qui suit un en-tête est la charge utile
• 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 mondial (avec un petit i signifie une interconnexion de réseaux)
• MTU est féminin.
• Auto-configuration, un - après Auto
• interopérer, sans tiret
• 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 abréviation donner l'abréviation puis la signification entre parenthèses et italique
  • ex: PI (Provider Independent).
• RFC est masculin
• Implémentation => mise en oeuvre

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'activité.
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 reference</ref>

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

<references />

Une référence 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

Pour aller plus loin

Tous les RFC cités dans le texte doivent avoir le titre d'indiqué dans la section pour aller plus loin. Ils doivent être triés par ordre croissant de numéro. Si une analyse de Bortzmeyer existe, un lien URL doit être ajouté. Exemple:

RFC et leur analyse par S. Bortzmeyer :

• RFC 1918 Address Allocation for Private Internets Analyse