Modifications pour le document Documenter l’aide en ligne

Résumé

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

Détails

Propriétés de la Page

Auteur du document

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

Contenu

...	...	@@ -1,5 +3,3 @@
1		-**PAGE EN COURS DE REDACTION**
2		-
3	3	(% class="mark small" %)**Version 4.5.54 et ultérieures**
4	4
5	5	|(% style="width:840px" %)(((
...	...	@@ -11,65 +11,80 @@
11	11	)))
12	12
13	13	(((
14		-= L'aide en ligne : un appui à la saisie dans Flora =
	12	+= À quoi sert l'aide en ligne dans Flora ? =
15	15
	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.
16	16
17		-L’aide en ligne **accompagne les utilisateurs** dans la compréhension et l’utilisation des champs présents dans les différentes tables de Flora.
18		-Elle contribue à garantir une saisie homogène, cohérente et conforme aux pratiques définies par votre institution. Elle complète les documents de référence internes et les procédures métiers du musée.
19		-Son objectif est de traduire concrètement ces règles directement dans l’interface de Flora, au plus près des champs utilisés par les équipes au quotidien.
	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.
20	20
21		-Concrètement, l’aide en ligne permet de :
	18	+**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**.
22	22
23		-* **Expliquer le contenu attendu dans un champ**.
24		-* **Formaliser les règles de saisie propres à l’institution** (abréviations autorisées, vocabulaire contrôlé, conventions d’écriture, etc.).
25		-* **Donner accès à des ressources externes de référence** (textes réglementaires, chartes internes, normes, guides méthodologiques).
26		-* **Harmoniser les pratiques et éviter les erreurs d’interprétation**, notamment dans les équipes élargies ou en cas de renouvellement des agents.
	20	+>(% class="small" %)Cas d'usage:
27	27
28		-Par défaut, **l’aide en ligne est redirigée vers l’aide disponible sur le wiki officiel**. Cette documentation est actuellement en cours de rédaction et d’enrichissement par l’équipe de Flora Software.
	22	+(((
	23	+>(% class="small" %)Expliquer le contenu attendu dans un champ.
29	29
30		-Elle constitue une **base commune de référence pour l’ensemble des utilisateurs**.
	25	+(((
	26	+>(% class="small" %)Formaliser les règles de saisie propres à l’institution.
31	31
32		-Toutefois, chaque institution a la possibilité d**’adapter cette aide à ses propres pratiques**.
	28	+>(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
33	33
34		-= Personnaliser l'aide en ligne =
	30	+>(% class="small" %)Donner accès à des ressources externes de référence.
35	35
36		-Lorsqu’un musée crée une **aide en ligne personnalisée** pour un champ :
	32	+>(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
	33	+)))
	34	+)))
37	37
38		-* le contenu standard issu du** wiki est automatiquement masqué**
39		-* seul le **contenu rédigé localement est affiché**
	36	+(% class="box successmessage" %)
	37	+(((
	38	+**Bonnes pratiques : **
40	40
41		-Si cette personnalisation est supprimée, l’aide du wiki réapparaît automatiquement.
	40	+**Présentation et lisibilité**
42	42
43		-Cette **personnalisation est strictement locale** : elle s’applique uniquement à la base de données de l’institution qui l’a créée.
44		-Elle ne modifie pas le contenu du wiki et n’a aucun impact sur les autres institutions.
	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é.
45	45
	47	+**Contenu et cohérence métier**
46	46
47		-== Identifier le nom interne du champ ou du bloc ==
	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.
48	48
49		-Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs.
	53	+**Suivi et maintenance**
50	50
51		-Pour cela :
	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.
	58	+)))
52	52
53		-1. Faites un **clic droit** sur le libellé du champ
54		-1. Choisir **Afficher informations**
55		-1. **Copiez le nom interne **du champ (ligne name)
	60	+= Identifier le nom interne du champ ou du bloc =
56	56
57		-[[//Clic droit - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	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 :
58	58
	64	+* Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.
	65	+* Vous pouvez aussi faire un clic droit sur le libellé et choisir **Afficher informations** pour copier directement le nom interne.
59	59
60		-[[//Nom interne du champ//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	67	+>(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
61	61
	69	+[[//Ex. Biens : survol d'un libellé et affichage du nom interne en infobulle//>>image:1744363912649-947.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
62	62
63		-== Ouvrir l’éditeur d’aide en ligne ==
64	64
65		-1. Rendez-vous dans l'espace de travail **Administration, menu Paramétrage, Aide en ligne**
66		-1. Dépliez la rubrique** Aide à la saisie**
67		-1. Choisir la source et la table
68		-1.
	72	+[[//Ex. Biens : clic droit sur le champ - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
69	69
70	70
	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"]]
71	71
72	72
	78	+= Ouvrir l’éditeur d’aide en ligne =
	79	+
	80	+Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
	81	+
	82	+Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
	83	+
	84	+Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
	85	+
73	73	[[//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"]]
74	74
75	75
...	...	@@ -106,9 +106,14 @@
106	106	(((
107	107	**Bonnes pratiques : **
108	108
109		-* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
110		-* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
	122	+**Présentation et clarté**
	123	+
	124	+* Uniformisez la présentation : adoptez une structure homogène (définition, usage, remarques).
	125	+* Soyez clairs et concis : rédigez des explications courtes et directement utiles.
111	111	* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
	127	+
	128	+**Contenu et cohérence**
	129	+
112	112	* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
113	113	* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
114	114	* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
...	...	@@ -151,7 +151,6 @@
151	151	**Bonnes pratiques : **
152	152
153	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.
154		-* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
155	155	)))
156	156
157	157	>(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
...	...	@@ -172,6 +172,8 @@
172	172
173	173	[[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
174	174
	192	+(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
	193	+​​​​​​​​​​​​​​
175	175
176	176	[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
177	177