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

...	...	@@ -1,38 +1,52 @@
1		-Version
	1	+(% class="mark small" %)**Version 4.5.54 et ultérieures**
2	2
	3	+|(% style="width:840px" %)(((
	4	+(% class="box" %)
	5	+(((
	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.
3	3
	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.
	9	+)))
4	4
	11	+(((
	12	+= A quoi sert l'aide en ligne dans Flora ? =
5	5
6		-= Définition =
	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.
7	7
8		-Chaque champ des différentes tables de Flora peut être documenté. Pour beaucoup de champs, cette aide n'est pas nécessaire car leur libellé suffit à en comprendre le sens et l'usage. Mais pour d'autres, il est nécessaire d'en expliquer le type de contenu, dans quelles fonctions ou processus ils interviennent ou même de donner accès à des ressources externes définissant des problématiques métiers très précises. C'est le cas par exemple des champs spécifiques aux musées et documentés sur la base Joconde du Ministère de la Culture.
	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**.
9	9
10		-Decalog a mis en place un nombre important de ces aides en ligne, désormais présentes sur ce wiki. Ce travail, toujours perfectible, est en perpétuelle progression.
	18	+>(% class="small" %)Cas d'usage:
11	11
12		-Par ailleurs, l'institution utilisatrice de Flora peut être amenée à redéfinir ou préciser, selon ses besoins internes, ces aides. Cela peut être fait dans le cadre d'une charte de saisie, par exemple.
	20	+(((
	21	+>(% class="small" %)Expliquer le contenu attendu dans un champ.
13	13
14		-L'accès à ces aides se fait champ par champ, par un simple clic droit sur le libellé du champ, via le menu "Afficher aide" :
	23	+(((
	24	+>(% class="small" %)Formaliser les règles de saisie propres à l’institution.
15	15
16		-[[image:1744363045589-792.png]]
	26	+>(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
17	17
	28	+>(% class="small" %)Donner accès à des ressources externes de référence.
18	18
19		-Non seulement les champs, mais aussi les blocs de champs peuvent être documentés :
	30	+>(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
	31	+)))
	32	+)))
20	20
21		-Exemple avec le bloc DATE_UTILISATION :
	34	+(% class="box successmessage" %)
	35	+(((
	36	+**Bonnes pratiques : **
22	22
23		-[[image:1744363311261-338.png]]
	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.
	48	+)))
24	24
25		-Aide en ligne du champs Numéro d'inventaire :
26		-
27		-[[image:1744363337995-749.png||data-xwiki-image-style-alignment="center"]]
28		-
29		-Il est ainsi tout à fait possible de décrire très concrètement l'ensemble des zones de saisies des différentes tables de Flora.
30		-
31		-Les aides en ligne de Flora ont deux supports possibles :
32		-
33		-* le wiki sur lequel vous êtes actuellement
34		-* des fichiers html présents sur votre applicatif Flora
35		-
36	36	== Comportement par défaut ==
37	37
38	38	Lors d'un appel au menu "Afficher aide" Flora recherche d'abord le fichier html correspondant sur votre applicatif. Si cette recherche est infructueuse, Flora interroge le wiki dans un second temps.
...	...	@@ -51,7 +51,7 @@
51	51	L'accès à ces pages, en modification, suppression ou création, se fait avec un compte autorisé, dans l'espace de travail "Administration", Menu "Paramétrage Aides en ligne" :
52	52
53	53
54		-[[image:1744363736609-747.png||data-xwiki-image-style-alignment="center"]]
	68	+[[image:1744363736609-747.png]]
55	55
56	56
57	57	== Connaître le nom d'un champ Flora ==
...	...	@@ -58,7 +58,7 @@
58	58
59	59	Pour retrouver le fichier d'aide en ligne à renseigner, il faut connaitre le nom informatique du champ concerné.. Par exemple, en musée, le champ "numéro d'inventaire" de la table des biens (MUS_BIEN) se nomme NUM_INVENTAIRE.
60	60
61		-[[image:1744363912649-947.png||data-xwiki-image-style-alignment="center"]]
	75	+[[image:1744363912649-947.png]]
62	62
63	63	Afin de connaître ce nom, il suffit d'aller sur une grille de saisie concernée et de survoler le libellé de l'élément à documenter
64	64
...	...	@@ -76,12 +76,12 @@
76	76
77	77	Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
78	78
79		-[[image:1744364340925-762.png||data-xwiki-image-style-alignment="center"]]
	93	+[[image:1744364340925-762.png]]
80	80
81	81	(% class="wikigeneratedid" %)
82	82	Choisir ensuite la source et la table du champ auquel on souhaite ajouter une aide en ligne. Taper sur les touches Ctrl et F de votre clavier afin de faire apparaitre une barre de recherche. Puis coller le nom informatique du champ dans la barre de recherche afin de le retrouver facilement dans la liste des champs.
83	83
84		-[[image:1744364568000-243.png||data-xwiki-image-style-alignment="center"]]
	98	+[[image:1744364568000-243.png]]
85	85
86	86	(% class="wikigeneratedid" %)
87	87	Cliquer sur le nom informatique du champ afin d'ouvrir l'éditeur html, puis saisir votre texte et cliquer sur sauvegarder.
...	...	@@ -103,3 +103,33 @@
103	103	Mais il serait pratique pour vous de créer un document traitement de texte dans lequel vous copie/collerez les contenus des champs personnalisés de chaque table.
104	104
105	105	Ce document sera la "mémoire" des spécificités de votre protocole de saisie, et pourra d'ailleurs être affiché sur la page d'accueil comme indiqué [[ici>>doc:2_Administration.Administration fonctionnelle.Documents de référence sur page d'aide.WebHome]]
	120	+)))
	121	+)))|(% style="width:300px" %)(((
	122	+(% class="box" %)
	123	+(((
	124	+**Sommaire**
	125	+
	126	+
	127	+)))
	128	+
	129	+(% class="box" %)
	130	+(((
	131	+**Aller plus loin**
	132	+
	133	+* [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
	134	+)))
	135	+
	136	+(% class="box" %)
	137	+(((
	138	+**Icônes principales**
	139	+)))
	140	+
	141	+(((
	142	+
	143	+
	144	+
	145	+
	146	+)))
	147	+)))
	148	+
	149	+