Modifications pour le document Documenter l’aide en ligne

Modifié par Doriane Bautista le 2025/09/17 16:01

Depuis la version 18.1
modifié par Doriane Bautista
sur 2025/09/11 14:14
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 24.1
modifié par Doriane Bautista
sur 2025/09/11 14:25
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -3,7 +3,7 @@
3 3  |(% style="width:840px" %)(((
4 4  (% class="box" %)
5 5  (((
6 -Dans Flora, chaque **champ** est accompagné d’une **aide en ligne **accessible directement depuis une **grille de saisie**. Par défaut, l’aide affichée provient du wiki.
6 +Dans Flora, chaque **champ ou bloc de champ** est accompagné d’une **aide en ligne **accessible directement depuis une **grille de saisie**. Par défaut, l’aide affichée provient du wiki.
7 7  
8 8  Elle peut toutefois être personnalisée : chaque institution a la possibilité de** rédiger sa propre aide en ligne** afin d’adapter les consignes à ses besoins internes et à sa charte de saisie.
9 9  )))
... ... @@ -11,14 +11,11 @@
11 11  (((
12 12  = A quoi sert l'aide en ligne dans Flora ? =
13 13  
14 -L’aide en ligne **accompagne** les utilisateurs dans la** compréhension **et l’**usage** des champs présents dans toutes les tables de Flora. Elle garantit une saisie cohérente et conforme aux pratiques définies par l’institution.
14 +L’aide en ligne **accompagne** les utilisateurs dans la **compréhension** et l’**usage **des **champs et blocs de champs **présents dans toutes les tables de Flora. Elle permet d’assurer une saisie cohérente et conforme aux pratiques définies par l’institution.
15 15  
16 -(% class="box infomessage" %)
17 -(((
18 -Par défaut, l’aide affichée provient du wiki Flora. Lorsqu’un musée crée une **aide en ligne personnalisée, celle du wiki disparaît au profit du contenu local**. Si la personnalisation est ensuite supprimée, l’aide du wiki réapparaît automatiquement. Cette personnalisation n’a d’effet que dans la base de données de l’institution qui l’a rédigée : elle ne modifie en rien les contenus du wiki et n’impacte pas les autres musées.
19 -)))
16 +**Lorsqu’un musée crée une** **aide en ligne personnalisée, celle du wiki disparaît au profit du contenu local.** Si la personnalisation est ensuite supprimée, l’aide du wiki réapparaît automatiquement. Cette personnalisation n’a d’effet que dans la base de données de l’institution qui l’a rédigée :** elle ne modifie en rien les contenus du wiki et n’impacte pas les autres musées**.
20 20  
21 ->(% class="small" %)Cas d'usages:
18 +>(% class="small" %)Cas d'usage:
22 22  
23 23  (((
24 24  >(% class="small" %)Expliquer le contenu attendu dans un champ.
... ... @@ -26,7 +26,7 @@
26 26  (((
27 27  >(% class="small" %)Formaliser les règles de saisie propres à l’institution.
28 28  
29 ->(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.)
26 +>(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
30 30  
31 31  >(% class="small" %)Donner accès à des ressources externes de référence.
32 32  
... ... @@ -34,24 +34,22 @@
34 34  )))
35 35  )))
36 36  
37 -
38 -L'accès à ces aides se fait champ par champ, par un simple clic droit sur le libellé du champ, via le menu "Afficher aide" :
34 +(% class="box successmessage" %)
35 +(((
36 +**Bonnes pratiques : **
39 39  
40 -[[image:1744363045589-792.png]]
38 +* **Être concis et clair** : rédiger des explications courtes, directement utiles à la saisie.
39 +* **Utiliser le vocabulaire métier partagé** : employer les termes définis dans la charte de saisie de l’institution.
40 +* **Préciser le contexte** : indiquer si le champ intervient dans un processus spécifique (inventaire, récolement, prêt, dépôt, restauration).
41 +* **Ajouter des exemples concrets** : illustrer les valeurs attendues pour éviter toute ambiguïté.
42 +* **Uniformiser la présentation** : structurer les textes de la même manière pour tous les champs (définition, usage, remarques).
43 +* **Limiter la redondance** : éviter de copier-coller l’intégralité de l’aide du wiki, ne garder que ce qui est réellement utile ou adapté localement.
44 +* **Documenter les blocs de champs** : expliquer le rôle global du bloc en plus du détail des champs si nécessaire.
45 +* **Préserver une mémoire interne** : conserver une copie (Word, tableur, etc.) des aides personnalisées pour suivre l’évolution des consignes et faciliter la maintenance lors des mises à jour Flora.
46 +* **Vérifier l’accessibilité** : tester l’affichage de la pop-up dans les navigateurs utilisés et vérifier que les aides apparaissent correctement.
47 +* **Actualiser régulièrement** : mettre à jour les contenus quand les procédures internes ou les règles métier évoluent.
48 +)))
41 41  
42 -
43 -Non seulement les champs, mais aussi les blocs de champs peuvent être documentés :
44 -
45 -Exemple avec le bloc DATE_UTILISATION :
46 -
47 -[[image:1744363311261-338.png]]
48 -
49 -Aide en ligne du champs Numéro d'inventaire :
50 -
51 -[[image:1744363337995-749.png]]
52 -
53 -
54 -
55 55  == Comportement par défaut ==
56 56  
57 57  Lors d'un appel au menu "Afficher aide" Flora recherche d'abord le fichier html correspondant sur votre applicatif. Si cette recherche est infructueuse, Flora interroge le wiki dans un second temps.
... ... @@ -134,6 +134,8 @@
134 134  (% class="box" %)
135 135  (((
136 136  **Aller plus loin**
132 +
133 +* [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
137 137  )))
138 138  
139 139  (% class="box" %)