Modifications pour le document Documenter l’aide en ligne

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

Depuis la version 22.1
modifié par Doriane Bautista
sur 2025/09/11 14:21
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
... ... @@ -31,7 +31,22 @@
31 31  )))
32 32  )))
33 33  
34 +(% class="box successmessage" %)
35 +(((
36 +**Bonnes pratiques : **
34 34  
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 +)))
49 +
35 35  == Comportement par défaut ==
36 36  
37 37  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.