Guide de style des écrans d'aide

Ceci est un travail en cours et devrait être utilisé comme ligne directrice pour la création des écrans d'aide pour Joomla 3.x. Les écrans d'aide qui existent sur le Wiki Joomla! Docs sont accessibles par chaque installation Joomla! utilisant le système d'aide par défaut. En suivant ce guide de style, le Projet Joomla! peut offrir une cohérence à travers les écrans d'aide pour permettre une navigation plus facile.

Si vous avez une question, veuillez la poster sur la page de discussion associée à l'écran d'aide en cliquant sur l'onglet Discussion en haut de la page de l'écran d'aide.

Mise en page de l'écran d'aide

Description

Chaque écran d'aide devrait avoir une section "Description". Elle entre plus en détail sur ce que fait l'écran et est utilisée dans les tableaux d'écrans d'aide à travers ce wiki. Voici un exemple d'utilisation.

Il n'y a pas de format spécifique pour cette section car la description devrait être en corrélation directe avec le but et la fonctionnalité de l'écran. Il peut y avoir des sous-sections à la description qui décrivent des détails plus spécifiques. Essayez de garder la description courte et concise, si la description est longue alors envisagez d'utiliser des puces pour la résumer.

Comment y accéder

Chaque écran d'aide devrait avoir une section Comment y accéder qui donne les étapes requises pour atteindre l'écran qui est décrit. Cela peut être redondant car un utilisateur doit être sur l'écran d'administration afin d'avoir récupéré l'écran d'aide. Souvenez-vous que les écrans d'aide peuvent être récupérés d'un certain nombre de différentes façons. Par exemple, quelqu'un utilisant un moteur de recherche pour savoir comment faire quelque chose pourrait tomber sur un écran d'aide sur le wiki sans jamais avoir accédé au système d'aide.

Remarques :

• Si le moyen d'atteindre l'écran est à partir d'un autre écran alors le nom de cet écran devrait être un lien vers son écran d'aide.
• Vous "cliquez" sur les boutons, y compris les boutons de la barre d'outils, mais vous "sélectionnez" les liens de menu. Une utilisation cohérente de cette terminologie devrait aider les utilisateurs.
• Pour faciliter le rendu de la flèche droite ( → ), Ceci pointant → vers cela.

Capture d'écran

Capture d'écran montrant l'aspect général de l'écran.

Remarques :

• Les images de capture d'écran peuvent avoir n'importe quelle largeur, mais les images plus grandes devraient avoir le |800px ajouté dans la source.
• Le nom de fichier devrait suivre nos conventions de nommage standards pour les écrans d'aide. Help-3x-<chemin-du-menu-en-minuscules-séparé-par-des-tirets>-screen-en.png. Par exemple, une capture d'écran de l'écran du Gestionnaire d'articles serait [[File:Help-3x--content-article-manager-screen-en.png]].
• Le nom de fichier doit toujours inclure un code de langue à la fin du nom, pour l'anglais -en est ajouté.
• Vous pouvez utiliser des fichiers .png ou .jpg.

Champs du formulaire (par onglet)

Onglet Détails

Cette section ne doit être incluse que sur les écrans d'aide qui décrivent des écrans comprenant un formulaire. Cela inclut tous les écrans d'ajout/modification, mais aussi des écrans comme la Configuration globale du site et les fenêtres modales comme Help4.x:Components Article Manager Options.

Autres types d'onglets

Si les champs sont regroupés en ensembles de champs ou en onglets, regroupez-les sous des sous-titres.

En-têtes de colonnes

Cette section ne doit être incluse que sur les écrans d'aide qui décrivent des écrans de gestion de l'arrière-plan ; c'est-à-dire lorsqu'une liste d'éléments est affichée. Cette section doit décrire chacune des colonnes de la liste.

Filtres de liste

Cette section ne doit être incluse que sur les écrans d'aide qui décrivent des écrans de gestion de l'arrière-plan ; c'est-à-dire lorsqu'une liste d'éléments est affichée. Cette section doit décrire comment utiliser les filtres de liste pour filtrer le contenu de l'écran. Voir Screen.content.15#List_Filters pour un exemple de la version 1.5.

Paramètres

Cette section ne doit être incluse que sur les écrans d'aide où l'écran comporte un bouton de barre d'outils Paramètres qui ouvre un sous-écran de paramètres modal. S'il y a de nombreux paramètres et que l'écran d'aide deviendrait excessivement long s'ils devaient être décrits ici, alors créez un lien vers un écran d'aide séparé avec un suffixe "_Options". Par exemple, voir Components Article Manager Options.

Comme l'écran modal des paramètres est généralement organisé en onglets, vous devez ajouter une sous-section sous cette section pour chaque onglet. Par exemple, s'il y a un onglet intitulé "Mise en page de l'édition", vous devez ajouter un titre de troisième niveau portant ce nom et, dans cette sous-section, décrire chacun des champs disponibles. Vous devez commencer chaque sous-section par une capture d'écran du panneau de paramètres approprié.

Barre d'outils

Évidemment, cette section ne doit être incluse que sur les écrans d'aide où une barre d'outils est présente.

Décrit les boutons disponibles et leurs fonctions associées. Utilisez des chunks ici car beaucoup seront identiques pour différents écrans. Il est préférable de fournir une image de la barre d'outils.

Le premier mot doit toujours être un verbe et, à moins qu'il ne s'agisse d'un verbe irrégulier, il doit également se terminer par la lettre "s". Cela signifie que vous devez structurer la description comme si vous utilisiez le mot "this" comme sujet, mais en omettant le sujet de la phrase. Cela fera en sorte que la phrase soit en fait un fragment de phrase. Par exemple :

• Au lieu de "To find buried treasures, click this button."
  • Dites, "Finds buried treasures."
• Au lieu de "You can click this button to insert a picture of John Stamos into the current document."
  • Dites, "Inserts a picture of John Stamos."
• Au lieu de "Inform yourself that a picture of John Stamos is the same thing as a buried treasure."
  • Dites, "Informs you that a picture of John Stamos is the same thing as buried treasure."

Comme de nombreuses barres d'outils sont identiques sur plusieurs écrans, la convention de nommage des fichiers d'images pour les barres d'outils vise à faciliter la réutilisation des images de barre d'outils partout où cela est possible. Les images de la barre d'outils doivent suivre cette convention de nommage : Help<version>-Toolbar-<iconslist>.png où <iconslist> est une liste des légendes de la barre d'outils séparées par des '-'. Chaque mot doit commencer par une majuscule, les espaces et '&' étant supprimés. Par exemple : Help30-Toolbar-New-Edit-Delete-Options-Help.png

Traitement par lot

Cette section ne doit être incluse que sur les écrans d'aide où l'écran dispose d'une fonctionnalité de traitement par lot. Voir par exemple Help4.x:Components Banners Categories.

Astuces

Comme son nom l'indique, cette section doit inclure des astuces, conseils et suggestions pouvant aider un utilisateur à effectuer des tâches liées à l'écran.

Source : Joomla Help in the User Guide, publié sous la licence de documentation électronique Joomla! (JEDL).