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.DBA
	1	+XWiki.JDT

Contenu

...	...	@@ -1,3 +1,5 @@
	1	+**PAGE EN COURS DE REDACTION**
	2	+
1	1	(% class="mark small" %)**Version 4.5.54 et ultérieures**
2	2
3	3	|(% style="width:840px" %)(((
...	...	@@ -9,56 +9,65 @@
9	9	)))
10	10
11	11	(((
12		-= À quoi sert l'aide en ligne dans Flora ? =
	14	+= L'aide en ligne : un appui à la saisie dans Flora =
13	13
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	+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.
17	17
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**.
	21	+Concrètement, l’aide en ligne permet de :
19	19
20		->(% class="small" %)Cas d'usage:
	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.
21	21
22		-(((
23		->(% class="small" %)Expliquer le contenu attendu dans un champ.
	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.
24	24
25		-(((
26		->(% class="small" %)Formaliser les règles de saisie propres à l’institution.
	30	+Elle constitue une **base commune de référence pour l’ensemble des utilisateurs**.
27	27
28		->(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
	32	+Toutefois, chaque institution a la possibilité d**’adapter cette aide à ses propres pratiques**.
29	29
30		->(% class="small" %)Donner accès à des ressources externes de référence.
	34	+= Personnaliser l'aide en ligne =
31	31
32		->(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
33		-)))
34		-)))
	36	+Lorsqu’un musée crée une **aide en ligne personnalisée** pour un champ :
35	35
36		-= Identifier le nom interne du champ ou du bloc =
	38	+* le contenu standard issu du** wiki est automatiquement masqué**
	39	+* seul le **contenu rédigé localement est affiché**
37	37
38		-Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
	41	+Si cette personnalisation est supprimée, l’aide du wiki réapparaît automatiquement.
39	39
40		-* Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.
41		-* Vous pouvez aussi faire un clic droit sur le libellé et choisir **Afficher informations** pour copier directement le nom interne.
	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	42
43		->(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
44	44
45		-[[//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"]]
	47	+== Identifier le nom interne du champ ou du bloc ==
46	46
	49	+Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs.
47	47
48		-[[//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"]]
	51	+Pour cela :
49	49
	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)
50	50
51		-[[//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"]]
	57	+[[//Clic droit - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
52	52
53	53
54		-= Ouvrir l’éditeur d’aide en ligne =
	60	+[[//Nom interne du champ//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
55	55
56		-Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
57	57
58		-Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
	63	+== Ouvrir l’éditeur d’aide en ligne ==
59	59
60		-Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
	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.
61	61
	70	+
	71	+
	72	+
62	62	[[//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"]]
63	63
64	64
...	...	@@ -95,14 +95,9 @@
95	95	(((
96	96	**Bonnes pratiques : **
97	97
98		-**Présentation et clarté**
99		-
100	100	* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
101	101	* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
102	102	* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
103		-
104		-**Contenu et cohérence**
105		-
106	106	* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
107	107	* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
108	108	* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
...	...	@@ -166,8 +166,6 @@
166	166
167	167	[[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
168	168
169		-(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
170		-​​​​​​​​​​​​​​
171	171
172	172	[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
173	173