Modèle de documentation

Description/introduction d’une ligne

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

Introduction d’une ligne

Premier paramètre

  • Description du paramètre
    • Gamme des valeurs acceptables
    • 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

  • Description du paramètre
    • Gamme des valeurs acceptables
    • Propriétés
    • Moment de l’utilisation du paramètre
    • etc.
  • Lien vers un exemple pratique de l’utilisation du paramètre

Développement

Ce que doivent savoir les développeurs

Enjeux connus

La liste des problèmes connus avec le plugiciel et si elles seront corrigées ou non.

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 connexes de la BOEW

Références

Liens externes pertinents