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,19 +37,27 @@
37	37	(((
38	38	**Bonnes pratiques : **
39	39
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.
	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.
50	50	)))
51	51
52		-= Repérer le nom interne du champ ou du bloc à documenter =
	60	+= Identifier le nom interne du champ ou du bloc =
53	53
54	54	Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
55	55
...	...	@@ -67,7 +67,7 @@
67	67	[[//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"]]
68	68
69	69
70		-= Accéder à l'éditeur d'aide en ligne =
	78	+= Ouvrir l’éditeur d’aide en ligne =
71	71
72	72	Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
73	73
...	...	@@ -78,7 +78,7 @@
78	78	[[//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"]]
79	79
80	80
81		-= Rechercher le champ ou le bloc à documenter =
	89	+= Localiser le champ ou le bloc à personnaliser =
82	82
83	83	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 :
84	84
...	...	@@ -97,13 +97,19 @@
97	97	[[//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"]]
98	98
99	99
100		-= Éditer l'aide en ligne =
	108	+= Rédiger et mettre en forme votre aide =
101	101
102	102	Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
103	103
104		-Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes.
	112	+* (((
	113	+**Saisir le contenu**
105	105
106		-Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
	115	+* Tapez directement votre texte dans l’éditeur.
	116	+* Vous pouvez aussi copier-coller l’aide issue du wiki et l’adapter à vos besoins internes.
	117	+)))
	118	+* (((
	119	+**Mettre en forme l’aide**
	120	+L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
107	107
108	108	* **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
109	109	* **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
...	...	@@ -111,9 +111,8 @@
111	111	* **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
112	112	* **Éléments enrichis** : caractères spéciaux, symboles.
113	113	* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
	128	+)))
114	114
115		-Une fois votre saisie terminée, cliquez sur **Sauvegarder** pour enregistrer votre personnalisation. **Dès la sauvegarde, l’aide en ligne par défaut issue du wiki est remplacée par votre aide personnalisée** : celle-ci ne s’affichera que dans votre base de données institutionnelle et n’aura aucun impact sur le wiki ni sur les autres musées.
116		-
117	117	(% class="box warningmessage" %)
118	118	(((
119	119	**Point d’attention : insérer des liens**
...	...	@@ -122,18 +122,39 @@
122	122	* Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
123	123	)))
124	124
	138	+* (((
	139	+**Sauvegarder la personnalisation**
	140	+
	141	+* Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
	142	+* Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
	143	+* Cette personnalisation ne s’applique que dans votre base institutionnelle et n’a aucun impact sur le wiki ni sur les autres musées.
	144	+)))
	145	+
	146	+(% class="box warningmessage" %)
	147	+(((
	148	+
	149	+)))
	150	+
125	125	(% class="box successmessage" %)
126	126	(((
127	127	**Bonnes pratiques : **
128	128
129		-* **Uniformisez la présentation** : adoptez une structure homogène (définition, usage, remarques).
130		-* **Soyez clairs et concis** : rédigez des explications courtes et directement utiles.
131		-* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
132		-* **Précisez le contexte** : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
133		-* **Ajoutez des exemples concrets** : illustrez les valeurs attendues pour éviter toute ambiguïté.
134		-* **Limitez les redondances** : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
135		-* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
136		-* **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.
	155	+**Présentation et clarté**
	156	+
	157	+* Uniformisez la présentation : adoptez une structure homogène (définition, usage, remarques).
	158	+* Soyez clairs et concis : rédigez des explications courtes et directement utiles.
	159	+* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
	160	+
	161	+**Contenu et cohérence**
	162	+
	163	+* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
	164	+* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
	165	+* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
	166	+* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
	167	+
	168	+**Suivi et maintenance**
	169	+
	170	+* 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
137	137	)))
138	138
139	139	>(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
...	...	@@ -157,10 +157,10 @@
157	157	(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
158	158	​​​​​​​​​​​​​​
159	159
160		-[[//Sauvegarde de l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	194	+[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
161	161
162	162
163		-= Consulter le résultat =
	197	+= Contrôler le rendu dans Flora =
164	164
165	165	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.
166	166
...	...	@@ -178,7 +178,7 @@
178	178
179	179	(% id="cke_bm_851S" style="display:none" %)
180	180
181		-= Revenir à l'aide en ligne du wiki =
	215	+= Rétablir l’aide par défaut du wiki =
182	182
183	183	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 :
184	184
...	...	@@ -193,7 +193,7 @@
193	193
194	194	**Résultat :** l’aide en ligne personnalisée disparaît et l’aide générique du wiki réapparaît automatiquement pour ce champ ou ce bloc.
195	195
196		-[[//Repérage nom interne du champ - survol//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	230	+[[//Repérage nom interne du champ - survol d'un champ//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
197	197
198	198
199	199	[[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]