Modifications pour le document Documenter l’aide en ligne

Résumé

• Propriétés de la Page (1 modifications, 0 ajouts, 0 suppressions)

Détails

Propriétés de la Page

Contenu

...	...	@@ -13,7 +13,7 @@
13	13
14	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		-**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**.
	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**.
17	17
18	18	>(% class="small" %)Cas d'usage:
19	19
...	...	@@ -31,22 +31,23 @@
31	31	)))
32	32	)))
33	33
34		-(% class="box successmessage" %)
35		-(((
36		-**Bonnes pratiques : **
	34	+
	35	+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" :
37	37
38		-* **Uniformisez la présentation** : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
39		-* **Soyez clairs et concis** : rédigez des explications courtes et immédiatement compréhensibles.
40		-* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
41		-* **Précisez le contexte d’utilisation** : indiquez si le champ ou le bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
42		-* **Ajoutez des exemples concrets** : illustrez les valeurs attendues afin d’éviter les ambiguïtés.
43		-* **Limitez les redondances** : ne recopiez pas intégralement l’aide du wiki, mais complétez-la ou adaptez-la selon vos besoins.
44		-* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
45		-* **Conservez une mémoire interne** : gardez une copie (Word, tableur, etc.) de vos aides personnalisées pour en assurer le suivi et la maintenance lors des mises à jour Flora.
46		-* **Vérifiez l’accessibilité** : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
47		-* **Mettez à jour régulièrement** : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
48		-)))
	37	+[[image:1744363045589-792.png]]
49	49
	39	+
	40	+Non seulement les champs, mais aussi les blocs de champs peuvent être documentés :
	41	+
	42	+Exemple avec le bloc DATE_UTILISATION :
	43	+
	44	+[[image:1744363311261-338.png]]
	45	+
	46	+Aide en ligne du champs Numéro d'inventaire :
	47	+
	48	+[[image:1744363337995-749.png]]
	49	+
	50	+
50	50	== Comportement par défaut ==
51	51
52	52	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.
...	...	@@ -129,8 +129,6 @@
129	129	(% class="box" %)
130	130	(((
131	131	**Aller plus loin**
132		-
133		-* [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
134	134	)))
135	135
136	136	(% class="box" %)