Changes between Initial Version and Version 1 of docs/guidelines


Ignore:
Timestamp:
Jun 16, 2016 9:29:24 AM (17 months ago)
Author:
rloubejac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • docs/guidelines

    v1 v1  
     1= Documentation - Guidelines =
     2
     3L'objectif est de conserver une certaine homogénéité dans la documentation utilisateur.
     4
     5== Description d'écrans ==
     6Privilégier les phrases courtes et les listes à puces.
     7Ex. :
     8{{{
     9Selon les droits, la fenêtre affiche :
     10- La liste des dossiers sur la partie gauche.
     11- La liste des applications sur la partie droite.
     12
     13}}}
     14
     15S'il y a une copie d'écran, la placer avant le texte descriptif.
     16
     17== Description d'actions ==
     18
     19Lorsqu'il s'agit de décrire un action, commencer par "Pour + verbe" et utiliser les listes à puces.
     20Ex. :
     21
     22{{{
     23Pour créer un dossier ou un projet :
     24- Cliquer sur le bouton + situé en bas à droit.
     25- Choisir « Insérer plusieurs pages… » dans le menu.
     26
     27}}}
     28
     29S'il y a une image, la placer au plus proche de l'élément décrit.
     30
     31== Convention de nom ==
     32Pour 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.
     33Ex. :
     34
     35{{{
     36- SB-Réglette de zoom => Simple Brief
     37- SB-Edition-Fenêtre principale.png => Simple Brief, Edition de page, Fenêtre principale.
     38}}}
     39