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

...	...	@@ -37,27 +37,19 @@
37	37	(((
38	38	**Bonnes pratiques : **
39	39
40		-**Présentation et lisibilité**
41		-
42		-* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
43		-* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
44		-* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
45		-* Ajoutez des exemples concrets : illustrez les valeurs attendues afin d’éviter toute ambiguïté.
46		-
47		-**Contenu et cohérence métier**
48		-
49		-* 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).
50		-* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
51		-* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
52		-
53		-**Suivi et maintenance**
54		-
55		-* 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.
56		-* Vérifiez l’accessibilité : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
57		-* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
	40	+* **Uniformisez la présentation** : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
	41	+* **Soyez clairs et concis** : rédigez des explications courtes et immédiatement compréhensibles.
	42	+* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
	43	+* **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).
	44	+* **Ajoutez des exemples concrets** : illustrez les valeurs attendues afin d’éviter les ambiguïtés.
	45	+* **Limitez les redondances** : ne recopiez pas intégralement l’aide du wiki, mais complétez-la ou adaptez-la selon vos besoins.
	46	+* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
	47	+* **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.
	48	+* **Vérifiez l’accessibilité** : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
	49	+* **Mettez à jour régulièrement** : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
58	58	)))
59	59
60		-= Identifier le nom interne du champ ou du bloc =
	52	+= Repérer le nom interne du champ ou du bloc à documenter =
61	61
62	62	Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
63	63
...	...	@@ -75,7 +75,7 @@
75	75	[[//Résultat : Nom interne du champ indiqué sur la première ligne//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
76	76
77	77
78		-= Ouvrir l’éditeur d’aide en ligne =
	70	+= Accéder à l'éditeur d'aide en ligne =
79	79
80	80	Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
81	81
...	...	@@ -86,7 +86,7 @@
86	86	[[//Espace de travail **Administration **~> menu **Paramétrage** ~> **Aide en ligne** ~> rubrique** Aide à la saisie**//>>image:1757594385587-551.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
87	87
88	88
89		-= Localiser le champ ou le bloc à personnaliser =
	81	+= Rechercher le champ ou le bloc à documenter =
90	90
91	91	Une fois dans le module d’édition des aides en ligne, vous devez localiser précisément le champ ou le bloc concerné avant de pouvoir le personnaliser. Procédez étape par étape :
92	92
...	...	@@ -105,7 +105,7 @@
105	105	[[//Résultat : l'éditeur d'aide en ligne apparait //>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
106	106
107	107
108		-= Rédiger et mettre en forme votre aide =
	100	+= Éditer l'aide en ligne =
109	109
110	110	Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
111	111
...	...	@@ -168,7 +168,7 @@
168	168	[[//Sauvegarde de l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
169	169
170	170
171		-= Contrôler le rendu dans Flora =
	163	+= Consulter le résultat =
172	172
173	173	Une fois votre aide personnalisée sauvegardée, il est essentiel de** vérifier son affichage** dans les grilles de saisie. Cette étape vous permet de **contrôler que le contenu rédigé apparaît bien en contexte** et qu’il remplace correctement, le cas échéant, l’aide du wiki.
174	174
...	...	@@ -186,7 +186,7 @@
186	186
187	187	(% id="cke_bm_851S" style="display:none" %)
188	188
189		-= Rétablir l’aide par défaut du wiki =
	181	+= Revenir à l'aide en ligne du wiki =
190	190
191	191	Si vous ne souhaitez plus conserver une aide en ligne personnalisée et préférez retrouver l’aide générique fournie par le wiki, procédez comme suit :
192	192