Comment utiliser l'aide en ligne

L'accès à l'aide en ligne

L'aide en ligne sera accessible à l'utilisateur au moyen d'un bouton Aide présent sur chaque page de l'application. Cela signifie que l'aide en ligne est une aide spécifique à une page (ou fenêtre) de l'application.


La fenêtre d'aide

La fenêtre d'aide s'affiche à droite de l'écran à une position pré-déterminée.


Six types de pages d'aide

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


Type

Description

Voir...

Description d'écran

Page d'aide pour décrire la signification des 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

Sommaire

Sommaire général de l'aide en ligne (pour les procédures et les descriptions d'écran)

Rechercher

Permet de rechercher une page de l’aide en ligne au moyen de mots-clés

 

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 à partir du logiciel.

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

Une list-box

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

Première partie (sans titre)

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

 

Pages de procédure

Appel contextuel

Les pages d'aide de type Procédure sont les pages qui ne seront pas appelées lors de l'appel contextuel à partir du logiciel. Elles sont accessibles à partir du sommaire général de l'aide en ligne.

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

Une list-box

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 les pages qui ne seront pas appelées lors de l'appel contextuel à partir du logiciel. Elles sont accessibles en cliquant directement sur le terme à définir (affiché sour forme de lien hypertexte).

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 n'est pas appelée lors de l'appel contextuel à partir du logiciel. Elle n'est accessible qu'à partir de la list-box tout en haut de la page d'aide.

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 n'est pas appelée lors de l'appel contextuel à partir du logiciel. Elle n'est accessible qu'à partir de la list-box tout en haut de la page d'aide.

Description

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

 

Page de recherche

Appel contextuel

La page de recherche n'est pas appelée lors de l'appel contextuel à partir du logiciel. Elle n'est accessible qu'à partir de la list-box.

Description

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