Comment utiliser l'aide en ligne

L'accès à l'aide en ligne

L'aide en ligne est accessible à l'utilisateur au moyen d'un bouton Aide présent sur chaque page de l'application.

La fenêtre d'aide

La fenêtre d'aide s'affiche à droite de l'écran à une position contrôlée par le concepteur de l'aide en ligne.

Six types de pages d'aide

L'aide en ligne comprend six types de page pour répondre aux besoins suivants :

Type

Description

Voir...

Description d'écran

Page d'aide pour décrire les données de la fenêtre courante du logiciel.

Procédure

Page de description d'une procédure du logiciel

Entrée de glossaire

Page donnant la signification d'un mot ou d'un acronyme

Glossaire général

Compilation de toutes les entrées de glossaire dans une seule page

Conventions typographiques Décrit les conventions typographiques présentes dans les pages d'aide

Sommaire

Sommaire général de l'aide en ligne

Rechercher

Permet de rechercher une page de l’aide en ligne au moyen de mots-clefs

 

Pages de description d'écran

Appel contextuel

Les pages d'aide de type Description d'écran sont les pages qui seront appelées lors de l'appel contextuel (c'est à dire sur clic sur le bouton d'aide)

Description

Ce type de page se compose des éléments suivants :

Élément

Fonction

Titre de la page d'aide

Titre de la page d'aide

Un Menu déroulant

Permettre l'accès direct au sommaire de l'aide en ligne et aux sous-parties de cette page d'aide

Rôle

Détailler le rôle de la fenêtre concernée

Actions

Détailler les actions possibles à partir de cette fenêtre

Description de la page

Détailler toutes les données présentes sur la fenêtre de l'application

Messages d'erreur

Détailler Les messages d'erreur pouvant intervenir sur la page

 

Pages de procédure

Appel contextuel

Les pages d'aide de type Procédure sont accessibles à partir du sommaire général de l'aide en ligne ou à partir de l'image

Description

Ce type de page se compose des éléments suivants :

Élément

Fonction

Titre de la page d'aide

Titre de la page d'aide décrivant la procédure

Un menu déroulant

Permettre l'accès direct au sommaire de l'aide en ligne et au glossaire général

Première partie (sans titre)

Introduction de la procédure (description du contexte d'utilisation de la procédure et du point de départ des actions à effectuer)

Listes des actions

Détailler les actions à effectuer pour exécuter la procédure

Fin de la procédure

Détailler les conséquences de la procédure et en particulier le nom de la fenêtre finale de l'application

 

Pages d'entrée de glossaire

Appel contextuel

Les pages d'aide de type Entrée de glossaire sont sont accessibles à partir de l'image à côté du terme à définir.

Description

Ce type de page se compose des éléments suivants :

Élément

Fonction

Mot à définir

 

Définition

Définition du terme

 

Page de Glossaire général

Appel contextuel

La page de glossaire est accessible uniquement à partir du menu déroulant.

Description

Cette page permet de regrouper toutes les entrées de glossaire dans une seule page synthétique.

 

Page de Sommaire général

Appel contextuel

La page de sommaire général est accessible uniquement à partir du meu déroulant

Description

Cette page permet de consulter toutes les pages de procédures et toutes les pages de description d'écran.

 

 

Page de Conventions typographiques

Appel contextuel

La page de convention typographique est accessible uniquement à partir du meu déroulant

Description

Cette page descrit les conventions typographiques qui seront utilisés dans les écrans d'aide.

Page de recherche

Appel contextuel

La page de recherche est accessible uniquement à partir du menu déroulant

Description

Cette page permet de rechercher une page de l’aide en ligne au moyen de mots-clefs.