Modifications pour le document Documenter l’aide en ligne

Résumé

• Propriétés de la Page (1 modifications, 0 ajouts, 0 suppressions)
• Pièces jointes (0 modifications, 1 ajouts, 0 suppressions)
  • 1757600253202-543.png

Détails

Propriétés de la Page

Contenu

...	...	@@ -5,7 +5,7 @@
5	5	(((
6	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		-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.
	8	+Elle peut toutefois être personnalisée : chaque institution a la possibilité de** créer sa propre aide en ligne** afin d’adapter les consignes à ses besoins internes et à sa charte de saisie.
9	9	)))
10	10
11	11	(((
...	...	@@ -13,6 +13,8 @@
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	+Elle vient en appui des documents de référence internes comme la **charte de saisie**, la **charte de nommage** ou les **processus métiers** propres au musée. Elle permet ainsi de traduire concrètement ces règles dans l’interface de Flora, au plus près des champs utilisés par les équipes.
	17	+
16	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:
...	...	@@ -35,19 +35,27 @@
35	35	(((
36	36	**Bonnes pratiques : **
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.
	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.
48	48	)))
49	49
50		-= Repérer le nom informatique du champ ou du bloc à documenter =
	60	+= Identifier le nom interne du champ ou du bloc =
51	51
52	52	Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
53	53
...	...	@@ -65,7 +65,7 @@
65	65	[[//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"]]
66	66
67	67
68		-= Accéder à l'éditeur d'aide en ligne =
	78	+= Ouvrir l’éditeur d’aide en ligne =
69	69
70	70	Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
71	71
...	...	@@ -76,7 +76,7 @@
76	76	[[//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"]]
77	77
78	78
79		-= Rechercher le champ ou le bloc à documenter =
	89	+= Localiser le champ ou le bloc à personnaliser =
80	80
81	81	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 :
82	82
...	...	@@ -95,11 +95,11 @@
95	95	[[//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"]]
96	96
97	97
98		-= Éditer l'aide en ligne =
	108	+= Rédiger et mettre en forme votre aide =
99	99
100	100	Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
101	101
102		-Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes.
	112	+1. Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes.
103	103
104	104	Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
105	105
...	...	@@ -110,7 +110,8 @@
110	110	* **Éléments enrichis** : caractères spéciaux, symboles.
111	111	* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
112	112
113		-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.
	123	+(% start="2" %)
	124	+1. 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.
114	114
115	115	(% class="box warningmessage" %)
116	116	(((
...	...	@@ -124,14 +124,22 @@
124	124	(((
125	125	**Bonnes pratiques : **
126	126
127		-* **Uniformisez la présentation** : adoptez une structure homogène (définition, usage, remarques).
128		-* **Soyez clairs et concis** : rédigez des explications courtes et directement utiles.
129		-* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
130		-* **Précisez le contexte** : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
131		-* **Ajoutez des exemples concrets** : illustrez les valeurs attendues pour éviter toute ambiguïté.
132		-* **Limitez les redondances** : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
133		-* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
134		-* **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.
	138	+**Présentation et clarté**
	139	+
	140	+* Uniformisez la présentation : adoptez une structure homogène (définition, usage, remarques).
	141	+* Soyez clairs et concis : rédigez des explications courtes et directement utiles.
	142	+* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
	143	+
	144	+**Contenu et cohérence**
	145	+
	146	+* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
	147	+* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
	148	+* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
	149	+* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
	150	+
	151	+**Suivi et maintenance**
	152	+
	153	+* 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
135	135	)))
136	136
137	137	>(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
...	...	@@ -155,10 +155,10 @@
155	155	(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
156	156	​​​​​​​​​​​​​​
157	157
158		-[[//Sauvegarde de l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	177	+[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
159	159
160	160
161		-= Consulter le résultat =
	180	+= Contrôler le rendu dans Flora =
162	162
163	163	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.
164	164
...	...	@@ -176,7 +176,7 @@
176	176
177	177	(% id="cke_bm_851S" style="display:none" %)
178	178
179		-= Revenir à l'aide en ligne du WIKI =
	198	+= Rétablir l’aide par défaut du wiki =
180	180
181	181	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 :
182	182
...	...	@@ -189,9 +189,9 @@
189	189	1. **Ouvrez l’éditeur HTML** associé au champ ou au bloc.
190	190	1. **Cliquez sur Delete** pour supprimer l’aide personnalisée.
191	191
192		-À partir de ce moment, l’aide en ligne du wiki réapparaît automatiquement pour ce champ ou ce bloc.
	211	+**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.
193	193
194		-[[//Repérage nom interne du champ - survol//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	213	+[[//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"]]
195	195
196	196
197	197	[[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
...	...	@@ -220,6 +220,7 @@
220	220	**Aller plus loin**
221	221
222	222	* [[Comprendre les sources et les tables dans Flora>>doc:2_Administration.Administration fonctionnelle.Présentation des sources et des tables.WebHome||target="_blank"]]
	242	+* [[Insérer un document interne pour accueil>>doc:2_Administration.Administration fonctionnelle.Documents de référence sur page d'aide.WebHome||target="_blank"]]
223	223	* (((
224	224	[[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
225	225	)))
...	...	@@ -228,13 +228,8 @@
228	228	(% class="box" %)
229	229	(((
230	230	**Icônes principales**
231		-)))
232	232
233		-(((
234		-
235		-
236		-
237		-
	252	+* [[image:1757600253202-543.png||height="45" width="45"]] Paramétrages
238	238	)))
239	239	)))
240	240

1757600253202-543.png

Auteur

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.DBA

Taille

...	...	@@ -1,0 +1,1 @@
	1	+6.3 KB

Contenu