Modèle de documentation

english

• description/introduction d’une ligne

Table of Contents Aperçu Objet Raison d’être Mise en œuvre Paramètres/options Premier paramètre/option Deuxième paramètre Troisième paramètre, etc. Développement Enjeux connus Avenir Antécédents de la version Pages connexes Références

Aperçu

• description sur plusieurs lignes/dans un paragraphe

Objet

• description de l’objet de la fonctionnalité

Raison d’être

• description du fonctionnement
• explication du besoin
• quand doit-on l'utiliser?
• quand ne pas l'utiliser?

Mise en œuvre

• description de la mise en œuvre pour l’utilisateur
• lien vers des exemples pratiques de base

Paramètres/options

• introduction d’une ligne

Premier paramètre/option

• description du paramètre :
  • gamme des valeurs exemptées
  • propriétés
  • moment de l’utilisation du paramètre
  • etc.
• lien vers un exemple pratique de l’utilisation du paramètre

Deuxième paramètre

Troisième paramètre, etc.

Développement

• ce que doivent savoir les développeurs

Enjeux connus

Avenir

• les prochains plans :
  • modifications proposées
  • nouveautés
  • etc.

Antécédents de la version

• description
• lien vers la description des projets engagés

Pages connexes

• autres pages dans le wiki qui portent sur le sujet

Références

• liens externes pertinents