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.

Le gabarit couleur sera lilas pour le manuel France, bleu pour le manuel Espagne, Gris pour le manuel Anglais.

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.

====== Titre de l'écran liste ======

Cet écran permet de ... [décrire la fonctionnalité].

== Activation ==
(éventuellement)
Il n'est accessible qu'aux utilisateurs titulaires du [[fr:wiki:utilisateurs:privileges#onglet_autres|privilège de Gestion RH]].

== Accessibilité ==
(éventuellement)
Il n'est accessible qu'aux utilisateurs titulaires du [[fr:wiki:utilisateurs:privileges#onglet_autres|privilège de Gestion RH]].

===== Liste de XXXXX =====

//**Accès : ** RH -> Équipe mettre ici les enchaînements de menus //

{{:fr:wiki:utilisateurs:parcourspro_05.png?direct|}} mettre ici une copie écran.

Ici, la description de l'écran

=== Menu contextuel ===

{{:fr:wiki:utilisateurs:rh_03.png?nolink|}} -> image du menu 

Ici, la description du menu contextuel

===== Fiche XXXX =====

Présenter la fiche 

{{:fr:wiki:utilisateurs:rh_02.png?nolink|}} mettre une image de la fiche

Détailler le fonctionnement de la fiche

-----------------
ℹ️ **Autres articles "Utilisateurs"**

<nspages fr:wiki:utilisateurs -nbCol=2 -textPages="" -h1 -r -simpleLineBreak >

====== NOMEXTENTION : l'objet de l'extension ======

===== Présentation =====

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.

{{youtube>zgF1X4nks2g?widthxheight=560x315|Présentation de Gestan }}


===== Pré-requis =====

A indiquer ici éventuellement

===== Paramétrage =====
//**Accès :** Outils → Paramètres de l'application → Paramétrage des extensions -> xxxx//

[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

===== Utilisation =====

Détaillez ici le fonctionnement de votre extension.

Ou alors :

===== Liste des xxxxxx =====

//**Accès :** menu → menu → menu//

Détaillez ici le fonctionnement de l'écran.


===== Versions =====

<btn type="primary" size="sm" icon="glyphicon glyphicon-user">[[https://www.lcpstudio.fr|  Extension éditée par XXX Studio]]</btn>

^Version ^Date ^Observations ^
| 3.15.xx.00 | 00/00/00 | Première version |

ℹ️ Autres articles “Partenaires”