Documentation - Guidelines

L'objectif est de conserver une certaine homogénéité dans la documentation utilisateur.

Version

Indiquer systématiquement le numéro de version concernée.

Description d'écrans

Privilégier les phrases courtes et les listes à puces. Ex. :

Selon les droits, la fenêtre affiche :
- La liste des dossiers sur la partie gauche.
- La liste des applications sur la partie droite.
…

S'il y a une copie d'écran, la placer avant le texte descriptif.

Description d'actions

Lorsqu'il s'agit de décrire un action, commencer par "Pour + verbe" et utiliser les listes à puces. Ex. :

Pour créer un dossier ou un projet :
- Cliquer sur le bouton + situé en bas à droit.
- Choisir « Insérer plusieurs pages… » dans le menu.
…

S'il y a une image, la placer au plus proche de l'élément décrit.

Convention de nom

Pour les images, lorsque cela se rapporte à une application, commencer le nom par l'abréviation de l'application concernée et éventuellement par l'endroit dans l'app ou cela se trouve. Ex. :

- SB-Réglette de zoom => Simple Brief
- SB-Edition-Fenêtre principale.png => Simple Brief, Edition de page, Fenêtre principale.