La rédaction des pages d'aide doit faire l'objet d'un soin minutieux.

Elle doit chercher à atteindre les quatre objectifs suivants :

• claire,
• précise,
• concise,
• exhaustive.

Attention à la qualité de la langue : orthographe, syntaxe, construction des phrases et des paragraphes. Évitez la verbosité (“Il semble que la perfection soit atteinte non quand il n'y a plus rien à ajouter, mais quand il n'y a plus rien à retrancher.”).

Détourez les copies d'écran avec précision (utilitaire vivement recommandé : Faststone Capture). Format recommandé : png (apparemment plus performant que du jpg sur des copies d'écran). Nommer les images avec un nom en rapport, par exemple pour la page famille de produit, famprod_01.png, famprod_02.png, etc, pour les images figurant sur une même page). Les stocker dans le même namespace.

Pour mettre des zones en évidence dans la copie d'écran, utilisez la fonction de numérotation de FastStone capture,

et la notation correspondante : 1.

Pour tout ce qui est libellés de bouton ou de champs, ainsi que les libellés des champs, mettez les en gras. Par exemple : “cliquez sur le bouton Valider”.

Les liens vers des sites externes ne sont pas autorisés. Le seul lien autorisé est celui du formulaire d'achat quand l'extension est en vente via le site du partenaire.

Ci-dessous une page standard de documentation concernant une extension.

Cette extension permet de […détailler ici les fonctionnalités principales de l'extension…].

Vous pouvez mettre une video si vous en avez fait une.

A indiquer ici éventuellement

Le paramétrage s'effectue via le menu Outils → Paramètres de l'application → Paramétrage des extensions.

[Laissez ce paragraphe tel quel, complétez le éventuellement avec les précisions nécessaires]

Détaillez ici le paramétrage :

• faites une copie d'écran du paramétrage
• détaillez les champs et les fonctions

Détaillez ici le fonctionnement de votre extension.

Extension éditée par XXX Studio

Autres articles “Extensions”