ADOBE RoboHelp Office 2002 User Manual [fr]

Les informations contenues dans ce document peuvent changer sans préavis. Le logiciel décrit dans le présent document est fourni sous couvert d'un contrat de licence ou d'un accord de non-divulgation. Son utilisation et sa reproduction ne sont autorisées que dans la mesure où elles sont conformes aux termes de ces accords. Aucune partie de la présente publication ne peut être reproduite, stockée dans un système de recherche automatique, ni transmise sous quelque forme ou par quelque moyen, électronique ou mécanique, que ce soit, y compris photocopie et enregistrement, à toute autre fin que l'utilisation personnelle de l'acheteur sans l'autorisation écrite de eHelp Corporation.

eHelp Corporation 10590 West Ocean Air Drive San Diego, CA 92130 États-Unis

www.ehelp.com

MARQUES DE FABRIQUE

ActiveEdit®, ActiveTest®, Blue Sky®, Blue Sky Software®, Contents Tab Composer®, eHelp™, Help To Source®, Hotspot Studio®, HTML Help Studio®, ReSize™, RoboHelp®, RoboInfo™, RoboInsight™, Smart Publishing Wizard™, Software Video Camera®, WebHelp®, WebSearch™, What's This? Help Composer®, WinHelp 2000®, WinHelp BugHunter®, WinHelp Find+®, WinHelp Graphics Locator®, WinHelp HyperViewer® et WinHelp Inspector® sont des marques de fabrique ou marques déposées de eHelp Corporation aux États-Unis et dans d'autres pays. Microsoft et Windows sont des marques déposées de Microsoft Corporation. Les autres marques et produits sont des marques de fabrique ou marques déposées de leurs détenteurs respectifs et devraient être respectés en tant que tels.

Rév-04/02

Table des matières

Chapitre 1 Pour commencer ______________________________________ 1

Gamme de produits RoboHelp____________________________________________2

Enterprise _________________________________________________________2 Professional ________________________________________________________3

Standard __________________________________________________________3 Ouverture et fermeture du programme_____________________________________4 Création et ouverture de projets__________________________________________5 RoboHelp HTML et RoboHelp Classic _______________________________________6 Vous découvrez RoboHelp ? _____________________________________________8 Contact avec eHelp Corporation __________________________________________ 9

Siège social ________________________________________________________9

Service de vente ____________________________________________________9

Support technique __________________________________________________10

Service clientèle ___________________________________________________10

Remarque sur la documentation _______________________________________11

Chapitre 2 Principes de base de rédaction __________________________ 13

Que sont les formats de projets ? ________________________________________13

Caractéristiques de base _____________________________________________14 Stratégies de développement d’un projet __________________________________ 15

Fonctions supplémentaires pour votre projet _____________________________21 Gérer votre projet ____________________________________________________22

Utilisation de RoboHelp pour gérer des projets____________________________ 23

Chapitre 3 Didacticiel __________________________________________ 25

Partie I − Principes de base _____________________________________________25

Pour commencer ___________________________________________________26

Changer l’apparence ________________________________________________39

Fournir des outils de navigation _______________________________________58

Créer une table des matières _________________________________________75 Partie II — Élaboration de votre projet ____________________________________ 84

Introduction à la rédaction dans RoboHelp

Créer un index ____________________________________________________ 84

Travailler avec des images ___________________________________________ 94 Ajouter des séquences d’exploration ___________________________________ 98 Terminer le projet_________________________________________________ 101

Index _____________________________________________________105

Chapitre 1

Pour commencer

eHelp Corporation propose des outils de rédaction d’aide en ligne et de systèmes de support de performance. Ils vous permettent de réduire le temps et le coût de développement, améliorer la fonctionnalité de vos produits et augmenter productivité et satisfaction des utilisateurs finaux de vos applications basées sur le Web, applications de bureau ou de votre documentation de formation en ligne.

RoboHelp® offre un environnement de création souple mettant à votre disposition tout le nécessaire pour saisir et mettre en page un texte, créer des liens et autres éléments de navigation, insérer des images et des objets multimédias et ajouter des effets spéciaux. Avec RoboHelp, il existe de nombreuses manières d’organiser et gérer votre projet de façon à ce que vous puissiez vous concentrer sur la rédaction, la structure, la génération, le test et la livraison de votre produit fini.

Utilisez RoboHelp pour créer différents produits à partir d’un seul projet en fonction de vos besoins personnels et de vos utilisateurs. Les nombreuses fonctionnalités de RoboHelp sont conçues pour permettre la création des formules d’aide suivante : WebHelp Enterprise (produits basés sur serveur avec toutes les fonctions de WebHelp et davantage), WebHelp (aide fonctionnant sur diverses plates-formes et indépendante des navigateurs), RoboInfo (produit basé sur serveur pour systèmes de support de performance), HTML Help, JavaHelp, WinHelp Microsoft compilée et documentation imprimée. (Les différentes formes d’aide dépendent du type de produit RoboHelp installé.)

Ce guide présente RoboHelp, conseille des stratégies élémentaires de développement et de gestion des projets et propose un didacticiel permettant d’apprendre à élaborer un projet basé sur HTML.

Introduction à la rédaction dans RoboHelp

Gamme de produits RoboHelp

La gamme de produits RoboHelp s’adresse aux rédacteurs d’aide, aux rédacteurs techniques et aux développeurs à qui il incombe de créer une aide en ligne pour des applications basées sur le Web ou applications de bureau. Ce sont des logiciels de rédaction d’aide qui réduisent votre temps et votre coût de développement et qui vous offrent la possibilité de recueillir les commentaires des utilisateurs sur votre aide et vos applications. Ils permettent de plus l’amélioration de la productivité et de la satisfaction des utilisateurs finaux, tout en vous assurant une bonne évolutivité qui prend en compte le changement de vos besoins.

La gamme de produits RoboHelp comporte trois éditions : Enterprise, Professional et Standard.

Édition RoboHelp Fonctionnalités comprises

Enterprise

RoboHelp Enterprise

RoboHelp Enterprise est un logiciel intelligent d’aide basée sur serveur pour les applications basées sur le Web. RoboHelp Enterprise fournit non seulement un environnement de publication ayant fait ses preuves, mais aussi une option de recherche linguistique naturelle, un support intégré pour plusieurs auteurs collaborant sur un même projet, une intégration des outils logiciels courants (par ex. Word, Dreamweaver, FrontPage, etc.) et des rapports de commentaires tirés de questions d’utilisateur.

À la différence d’autres programme de création d’aide en ligne, RoboHelp Enterprise tire parti de la puissance de traitement côté serveur afin de vous permettre de mieux comprendre les problèmes de vos utilisateurs quant à l’aide et les applications que vous leur proposez. Le format WebHelp Enterprise de RoboHelp Enterprise possède toutes les fonctions de RoboHelp Office mais a l’avantage d’être basé sur serveur.

De pair avec le logiciel de serveur RoboEngine™ et la technologie de rapport RoboInsight™ , RoboHelp Enterprise éclaircit le mystère régnant autour de l’amélioration de l’aide en ligne et des applications basées sur le Web.

Chapitre 1 Pour commencer

Édition RoboHelp Fonctionnalités comprises

Professional

Standard

RoboHelp Office

RoboHelp Office est un logiciel de rédaction d’aide proposant des fonctions de navigation, organisation et indexation, de même que la possibilité de gérer des projets et de les compiler, tester et déboguer efficacement. RoboHelp Office vous permet de créer divers produits à partir d’un même projet, y compris WebHelp, Microsoft HTML Help, JavaHelp, Oracle Help et documentation imprimée. RoboHelp Office assure aussi une intégration à de nombreux outils courants, tels que Microsoft Word, Dreamweaver et FrontPage.

RoboHelp for Microsoft HTML Help

RoboHelp for Microsoft HTML Help est un logiciel de rédaction qui crée l’aide Microsoft HTML Help. Cet outil s’adresse aux rédacteurs d’aide, aux rédacteurs techniques et aux développeurs créant une aide basée sur HTML uniquement pour des applications fonctionnant dans Microsoft Windows. Ce programme réalise toutes les tâches d’arrièreplan pendant que vous créez un contenu et des éléments de navigation, ajoutez des images et effectuez la mise en forme.

RoboHelp for WinHelp

RoboHelp for WinHelp est un logiciel de rédaction d’aide, permettant la création de WinHelp, l’aide standard originale de Microsoft. RoboHelp for WinHelp s’adresse aux rédacteurs d’aide, aux rédacteurs techniques et aux développeurs créant une aide en ligne uniquement pour des applications fonctionnant dans Microsoft Windows et souhaitant que l’aide en ligne créée fonctionne aussi dans des versions plus anciennes de Microsoft Windows.

Remarque : Pour obtenir des renseignements sur les nouveautés de

RoboHelp, la configuration système et l’installation du programme, consultez le Guide d’installation.

Introduction à la rédaction dans RoboHelp

Ouverture et fermeture du programme

Une fois le programme installé, une icône RoboHelp Starter est affichée sur votre bureau. Vous pouvez utiliser RoboHelp Starter pour créer un projet, ouvrir un projet existant, importer des fichiers et projets ou utiliser les outils de productivité fournis avec RoboHelp.

Le RoboHelp Starter

Pour ouvrir le RoboHelp Starter :

 Double-cliquez sur l’icône RoboHelp Starter située sur votre bureau.

Pour fermer RoboHelp Starter :

 Cliquez sur situé dans le coin supérieur droit de la fenêtre.

Chapitre 1 Pour commencer

Création et ouverture de projets

Procédez comme suit pour créer ou ouvrir des projets.

Pour créer un projet dans RoboHelp :

1 Double-cliquez sur l’icône RoboHelp Starter

2 Assurez-vous que l’onglet New Project est affiché. Les types de projet

sont indiqués et accompagnés d’une brève description. (Les types de projet affichés sont fonction de l’édition RoboHelp que vous avez installée.)

3 Cliquez sur l’icône située à côté du type de projet que vous souhaitez

créer (pour de plus amples informations sur chaque type, cliquez sur More Info). Pour consulter la description de chaque type de projet, cliquez sur le lien tour.

RoboHelp s’ouvre et affiche le New Project Wizard.

4 Suivez les instructions affichées et cliquez sur Help pour plus

d’informations sur chaque boîte de dialogue. Une fois terminé, votre nouveau projet s’ouvre dans RoboHelp.

Pour ouvrir un projet dans RoboHelp :

1 Double-cliquez sur l’icône RoboHelp Starter

2 Cliquez sur l’onglet Open. Une liste des fichiers ouverts le plus récemment

s’affiche.

3 Double-cliquez sur le fichier que vous voulez ouvrir ou double-cliquez sur

More Files pour naviguer vers un autre dossier.

4 Dans Files of Type, cliquez sur le type de projet que vous voulez ouvrir

(par exemple, WebHelp Project (*.mpj)).

située sur votre bureau.

5 Sélectionnez un projet et cliquez sur Open.

Le projet s’ouvre dans RoboHelp.

Introduction à la rédaction dans RoboHelp

RoboHelp HTML et RoboHelp Classic

Les deux outils de rédaction fournis avec RoboHelp possèdent des interfaces et fonctions de base semblables, mais permettent la création de produits différents dans un environnement de travail différent.

RoboHelp HTML est équipé d’un éditeur WYSIWYG qui vous permet de travailler avec contenu, liens, images, effets spéciaux, feuilles de style et autres fonctions.

Environnement de travail de RoboHelp HTML

Pour ouvrir RoboHelp HTML :

1 Double-cliquez sur l’icône RoboHelp Starter

2 À partir du menu Application, sélectionnez RoboHelp HTML.

RoboHelp HTML s’ouvre et affiche le New Project Wizard.

3 Suivez les instructions affichées et cliquez sur Help pour plus

d’informations sur chaque boîte de dialogue. Une fois terminé, votre nouveau projet s’ouvre dans RoboHelp.

située sur votre bureau.

Chapitre 1 Pour commencer

Pour de plus amples informations sur l’utilisation de RoboHelp HTML, suivez le didacticiel du Chapitre 3 et reportez-vous à l’aide en ligne de RoboHelp.

RoboHelp Classic utilise Microsoft Word comme éditeur, ce qui vous permet de créer et développer votre projet dans un environnement qui vous est familier.

Environnement de travail de RoboHelp Classic

Pour ouvrir RoboHelp Classic :

1 Double-cliquez sur l’icône RoboHelp Starter

2 À partir du menu Application, sélectionnez RoboHelp Classic.

RoboHelp Classic s’ouvre et affiche le New Project Wizard.

3 Suivez les instructions affichées et cliquez sur Help pour plus

d’informations sur chaque boîte de dialogue. Une fois terminé, votre nouveau projet s’ouvre dans RoboHelp.

Pour de plus amples informations sur l’utilisation de RoboHelp Classic, reportezvous à l’aide en ligne (ouvrez le programme, sélectionnez le menu Help puis Contents & Index).

située sur votre bureau.

Introduction à la rédaction dans RoboHelp

Vous découvrez RoboHelp ?

Si vous découvrez RoboHelp ou la rédaction pour la première fois, ce guide vous aidera à vous lancer. Voici quelques ressources supplémentaires :

 Help Community : Le meilleur endroit pour trouver un support technique

en ligne et des renseignements sur le produit et l’industrie est véritablement la Help Community de eHelp. Découvrez des conseils sur les divers produits, obtenez l’aide de professionnels de votre domaine dans des groupes de discussion, trouvez des réponses à vos questions dans la base de connaissance, etc. Visitez http://www.helpcommunity.ehelp.com/ ou dans le RoboHelp Starter, sélectionnez le menu Help, puis Help Community Web Site.

 Didacticiel : Le Chapitre 3 de ce manuel contient un didacticiel vous

indiquant la manière de créer un projet basé sur HTML. Que ce soit avec RoboHelp Office ou RoboHelp Enterprise, ce didacticiel est divertissant et représente un moyen facile d’apprendre à connaître le programme et de découvrir les fonctions de RoboHelp.

Ce didacticiel est aussi disponible en ligne. Dans la fenêtre RoboHelp Starter, sélectionnez le menu Help puis sélectionnez RoboHelp HTML Tutorial.

 Aide en ligne : L’aide en ligne accompagnant RoboHelp fournit des

informations détaillées sur l’utilisation de chacune des fonctions du programme. Pour accéder à l’aide en ligne dans RoboHelp HTML ou RoboHelp Classic, ouvrez le programme, sélectionnez le menu Help puis Contents & Index.

 Aide au niveau de la fenêtre (ou aide contextuelle) : Dans presque

toutes les boîtes de dialogue ou fenêtres de RoboHelp, vous pouvez appuyer sur F1, ou cliquez sur le bouton Help pour obtenir des renseignements concernant l’élément en cours d’utilisation.

Chapitre 1 Pour commencer

Contact avec eHelp Corporation

eHelp est un leader mondial en matière de logiciel d’aide à l’utilisateur automatisée. Nos outils novateurs sont faciles à utiliser et améliorent considérablement la fonctionnalité d’applications.

Siège social

Adresse : eHelp Corporation

Téléphone : +1 858 847-7400 Fax : +1 858 847-1415 World Wide Web : www.ehelp.com Heures d’ouverture : Du lundi au vendredi

Service de vente

Contactez un représentant eHelp pour obtenir des renseignements sur les tous derniers produits eHelp, le plan d’abonnement eHelp, les options de mise à jour, les prix, etc. Pour toute question ou problème technique, contactez le support technique.

Contact avec votre représentant eHelp

Téléphone — Service de vente :

International (Canada compris) :

Fax — Service de vente :

World Wide Web : www.ehelp.com

Email — Service de vente :*

Heures d’ouverture : Du lundi au vendredi

10590 West Ocean Air Drive San Diego, CA 92130 États-Unis

6h00 à 17h00 Heure de la côte pacifique des États-Unis

+1 800 677-4946

+1 858 847-7900

+1 858 847-1416

sales@ehelp.com

6h00 à 17h00 Heure de la côte pacifique des États-Unis

*Si vous envoyez un email, veuillez inclure le nom de votre société, la ville et l’état (le cas échéant) pour assurer le traitement rapide de votre demande.

Introduction à la rédaction dans RoboHelp

Support technique

eHelp Corporation s’engage à ce que votre expérience soit la meilleure possible. Ses produits sont intuitifs et souples, pouvant s’adapter à vos besoins. Bien qu’ils soient de conception supérieure et d’utilisation simple, il arrive parfois que, en raison de problèmes, l’utilisateur puisse avoir besoin de nos ressources de support.

Remarque : Les services de support de eHelp Corporation dépendent du prix

 Pour connaître les heures de service et les détails concernant les genres de

support proposés, veuillez visiter notre site Web :

www.ehelp.com/support

 Pour consulter les ressources de support disponibles 24 heures sur 24, y

compris une base de connaissance et des groupes de discussion, veuillez visiter le site Web de la communauté d’aide de eHelp :

www.helpcommunity.ehelp.com

 Pour contacter le support technique via email, utilisez le lien Contact Us

sur le site Web de la communauté d’aide :

www.helpcommunity.ehelp.com/robohelp/contact/contactus.asp

 Pour tout problème d’installation et de support payant par téléphone

(requête unique, support de maintenance Silver et Gold), composez le +1 858 847-7960.

et des termes en vigueur au moment de l’utilisation des services.

Service clientèle

eHelp Corporation s’efforce de toujours fournir à ses clients le meilleur service possible. Notre nouveau site Web de service clientèle fournit une liste des questions les plus fréquemment posées et dispose des fonctions de recherche dans notre site, dont les résultats sont affichés dans un format facile à visualiser.

Contacter le service clientèle

Téléphone : +1 858 677-4946 World Wide Web : www.ehelp.com/support/customerservice.asp Email : customer.service@ehelp.com

Chapitre 1 Pour commencer

Remarque sur la documentation

eHelp Corporation s’efforce de publier des produits de documentation de la meilleure qualité possible et serait heureuse de savoir ce que vous en pensez. Pour toute remarque ou suggestion concernant nos guides d’aide en ligne ou imprimés, veuillez nous faire parvenir un email.

Vous êtes prié d’inclure les informations suivantes avec vos remarques :

 Nom du produit et numéro de version

 Manuel imprimé ou aide en ligne

 Titre du sujet (pour l’aide en ligne)

 Numéro de page (pour le manuel imprimé)

 Une brève description du contenu (par exemple, si vous avez lu des

instructions pas à pas incorrectes, contenant des fautes de grammaire dans un paragraphe spécifique, des informations qui devraient être clarifiées ou proposer plus de détails, etc.)

 Votre suggestion quant à la correction et/ou l’amélioration à apporter à la

documentation

Veuillez envoyer un email à :

documentation@ehelp.com

N’oubliez pas que cette adresse électronique n’est que valable pour faire part de vos commentaires concernant la documentation. Pour toute question technique, contactez le support technique.

Introduction à la rédaction dans RoboHelp

Chapitre 2

Principes de base de rédaction

Le présent chapitre s’adresse aux personnes souhaitant découvrir la rédaction en ligne ou effectuer un petit rappel de leurs aptitudes. Vous y trouverez des conseils sur la manière de travailler dans le programme, élaborer un processus de développement et gérer votre projet.

Grâce à sa souplesse, RoboHelp vous permet de travailler comme cela vous convient. À mesure que vous développez votre projet, vous découvrirez d’autres façons encore d’augmenter votre efficacité et de créer un produit répondant aux besoins de vos utilisateurs.

Que sont les formats de projets ?

Avant de développer votre projet et de livrer le produit fini, vous devez penser aux plates-formes et afficheurs utilisés, aux fonctions que chacun supporte et à vos objectifs. Certains des utilisateurs finaux ne possèdent qu’un type de navigateur sur leur système, tandis que d’autres en ont plusieurs. Par ailleurs, votre application hôte fonctionne probablement sur un type précis de plateforme.

Ces différences obligent les rédacteurs à bien étudier la manière de livrer des projets qui sont compatibles avec les afficheurs et plates-formes du public visé. Les formats de projets prennent ces facteurs en compte assurant un support et des fonctions de types variés.

Dans RoboHelp, vous pouvez créer des formats de projet différents (aussi appelés « formats d’aide » ou « formats de produit ») qui répondent aux besoins des utilisateurs finaux et à ceux de votre application. Les fichiers produits fonctionnent sur divers afficheurs et plates-formes, supportent des fonctions spécifiques et affichent des interfaces différentes. Ces différences peuvent sembler subtiles aux utilisateurs mais les auteurs doivent être pleinement conscients des caractéristiques des formats qu’ils créent.

Par exemple, si votre système se trouve au sein d’une application basée sur le Web et que vos utilisateurs finaux utilisent le navigateur de leur choix, vous pouvez sélectionner un format fonctionnant sur le Web et ne nécessitant pas de navigateur spécifique pour afficher le contenu correctement. Dans ce cas, vous devriez penser à utiliser WebHelp comme format de projet, car il fonctionne sur des plates-formes multiples et ne dépend pas d’un navigateur donné. Si vous avez besoin d’un moyen de fusionner des projets sur un serveur Web et visualiser les rapports d’informations de retour concernant l’utilisation de votre système, vous pouvez choisir RoboHelp Enterprise comme produit.

Introduction à la rédaction dans RoboHelp

Pour de plus amples informations sur la manière de sélectionner un format de projet, vous pouvez utiliser la visite guidée proposée dans RoboHelp Starter. Double-cliquez sur l’icône RoboHelp Starter située sur votre bureau et cliquez sur l’onglet New Project. Ensuite, cliquez sur le lien tour située en haut de la fenêtre.

Vous pouvez aussi vous reporter à l’aide en ligne de RoboHelp. Ouvrez RoboHelp et cliquez sur le menu Help, puis sélectionnez Contents & Index.

Caractéristiques de base

Bien qu’il existe des différences notables entre les divers formats de projets, ils présentent aussi certaines similitudes. Ci-dessous figurent quelques fonctions universelles :

 Navigation graphique et support d’organisation (par exemple, index multi-

niveaux et tables des matières)

 Sujets indépendants (liens qui ouvrent un sujet dans une petite fenêtre

s’affichant sur la fenêtre principale)

 Séquences d’exploration (liens qui permettent aux utilisateurs d’avancer ou

de reculer dans une série de sujets organisés dans un ordre précis).

 Références croisées intitulées Related Topics ou See Also (listes de liens

avec d’autres sujets contenant des sujets connexes)

 Recherche de texte entier (une fonction qui permet aux utilisateurs de

chercher des mots utilisés dans le contenu de sujets)

 Aide contextuelle (sujets fournissant des renseignements correspondant au

contenu de l’écran affiché)

Comme vous le constaterez par la suite, peu importe le format de projet que vous livrez, les stratégies de développement et de gestion de projet sont en règle générale identiques.

Chapitre 2 Principes de base de rédaction

Stratégies de développement d’un projet

Ci-dessous vous trouverez une stratégie conseillée de développement de projet dans RoboHelp. Une fois que vous avez créé votre projet et ajouté quelques sujets, vous pouvez réaliser ces tâches dans l’ordre que vous voulez (ou simultanément). Toutes les tâches ne sont pas indispensables à la livraison d’un système en ligne, mais il est recommandé d’en compléter la plupart afin de veiller à ce que vos utilisateurs tirent le meilleur parti de votre système. Chaque tâche comprend des éléments conseillés (« À faire ») avant de commencer chacune d’elles.

 Créer un projet

 Ajouter des sujets

 Ajouter un contenu

 Développer une table des matières

 Créer des liens

 Insérer des images

 Construire un index

 Générer et exécuter votre projet

 Tester votre projet

 Livrer le produit fini

Conseil : Pour de plus amples détails sur ces tâches, reportez-vous à l’aide en

ligne de RoboHelp.

Introduction à la rédaction dans RoboHelp

Créer un projet

Au sein des projets RoboHelp, vous pouvez gérer et organiser tous les fichiers nécessaires à la création du produit fini (appelé « produit »). Le projet comprend votre contenu ainsi que les propriétés que vous établissez, telles que l’aspect de la fenêtre du produit.

Au cours du développement, déterminez le format de projet que vous voulez créer, à savoir WebHelp, WebHelp Enterprise ou HTML Help. Votre choix est fonction du type d’application que vous créez et des afficheurs et plates-formes que vos utilisateurs finaux utiliseront vraisemblablement.

Reportez-vous au Chapitre 1 pour apprendre à créer un projet.

À faire : Décidez du nom de votre projet et de son emplacement de sauvegarde. Renseignez-vous sur les plates-formes et afficheurs dont vos utilisateurs finaux disposent car cela influence les sortes de fonctions disponibles dans votre projet et son mode de livraison. Ensuite, consultez l’aide en ligne de RoboHelp pour connaître les fonctions que chaque format de projet supporte.

Ajouter des sujets

Les sujets d’un projet en sont la clé de voûte. Ils affichent le contenu et contiennent liens, images et autres fonctions aidant les utilisateurs. Pendant le développement de votre projet, déterminez les types de sujets s’adaptant au mieux au contenu (voir « Ajouter un contenu » ci-après), rédigez les sujets pour qu’ils soient clairs et exacts, puis organisez-les pour qu’ils soient simples à trouver. Vous pouvez ajouter des sujets au début de votre projet ou à mesure que vous progressez, en fonction de vos besoins.

À faire : Décidez d’une convention pour nommer vos sujets. Par exemple, comment nommerez-vous des sujets de présentation (tels que « À propos du produit ABC » ou « Introduction du produit ABC ») ? Les utilisateurs peuvent retrouver des informations plus rapidement si différents types de sujet sont nommés de façon systématique.

Chapitre 2 Principes de base de rédaction

Ajouter un contenu

Pour ajouter du texte à vos sujets dans RoboHelp, la méthode est semblable au processus utilisé dans un programme de traitement de texte, mais votre public recherche des informations rapides à point nommé. Les sujets sont en règle générale brefs et contiennent une notion, un processus ou une idée principale dans chacun. Évitez que les utilisateurs aient à faire défiler la page pour lire les informations et n’oubliez pas que lorsque les utilisateurs accèdent à votre système, ils souhaitent obtenir des informations précises rapidement.

À faire : Déterminez les types d’information que vous voulez ajouter (présentation, processus, contexte, référence, etc.). Si vous êtes systématique dans le choix de format associé à chaque type d’information, les utilisateurs pourront trouver et utiliser ces informations plus efficacement. Par exemple, dans des sujets de processus, vous pouvez inclure une brève description du processus, les étapes et une image de l’interface utilisateur que vous décrivez.

Développer une table des matières

Les utilisateurs consultent la table des matières (TOC) non seulement pour accéder à des informations mais aussi pour connaître la structure de votre projet et les sujets qui y sont couverts. Profitez de la fonction Auto Create TOC qui vous permet de créer automatiquement une table des matières conformément à la structure de votre projet.

À faire : Pensez à la façon de consulter des informations qu’auront vos utilisateurs. Le cas échéant, connaissez-vous leurs habitudes de travail et l’ordre dans lequel ils pourraient réaliser leurs tâches ? Les utilisateurs serontils capables de retrouver des informations organisées par fonctions ou modules ou ont-ils l’habitude de voir des informations structurées différemment ? Préparez une table des matières qui leur paraîtra logique.

Introduction à la rédaction dans RoboHelp

Créer des liens

À la différence de livres imprimés, commençant par une table des matières et possédant des chapitres en ordre séquentiel, les informations en ligne ne sont pas linéaires, à savoir les utilisateurs peuvent commencer n’importe où et passer à d’autres sujets sans ordre spécifique, selon leurs besoins et le chemin qu’ils suivent pour y parvenir. Par conséquent, il est important de leur fournir les moyens de trouver ces informations.

Vos sujets devraient utiliser des liens de manière systématique pour que les utilisateurs puissent se déplacer facilement et rapidement dans l’aide. Si vous souhaitez veiller à la simplicité de l’aide, commencez par proposer des liens textuels (« hotspots » sur lesquels les utilisateurs cliquent pour afficher la destination) ; il est bon de ne pas inclure trop de liens dans chaque sujet.

À faire : Prévoyez une stratégie pour que la navigation soit évidente et utile. Comment traiterez-vous les références croisées ? (RoboHelp propose une multitude de façons de le faire, à savoir utilisation de boutons Related Topics et liens See Also.) Comment éviterez-vous que les utilisateurs se perdent dans votre système ?

Insérer des images

Les images permettent de communiquer des idées, parfois même mieux qu’un texte. En insérant captures d’écran, images, graphiques, illustrations ou autres types d’images, vous pouvez rendre vos sujets plus intéressants et expliquer des concepts plus en détails.

À faire : Décidez d’une convention d’appellation de vos graphiques et décidez aussi du type de format de fichier image que vous souhaitez utiliser (.GIF, .JPG, etc.). Utiliserez-vous fréquemment des images dans votre projet ou seulement pour certains types de sujet ?

Chapitre 2 Principes de base de rédaction

Construire un index

Vous pouvez élaborer un index en même temps que vous rédigez le contenu ou à la fin du projet. Pour vous assurer que tous les sujets sont indexés, certains auteurs utilisent une « règle », par exemple ils créent au moins cinq entrées par sujet. Pour créer automatiquement votre index, utilisez le Smart Index Wizard qui vous permettra de créer rapidement un index en fonction des mots et phrases de vos sujets.

La création d’index est généralement plus longue que prévue et ces index doivent de plus bénéficier d’une vérification de qualité. De cette manière, vous vous assurez que l’index est complet, exact et affiche les sujets correspondant aux entrées cliquées.

À faire : Décidez de l’aspect de votre index. Possèdera-t-il plusieurs niveaux ? Les entrées auront-elles des majuscules ? Utiliserez-vous des verbes ou des noms ? Le processus d’indexation inclut divers aspects. Il est donc conseillé de passer un peu de temps à y réfléchir, améliorer vos aptitudes de création d’index et de lui accorder suffisamment de temps.

Générer et exécuter votre projet

Pendant le développement d’un projet, vous devriez visualiser votre système du point de vue d’un utilisateur final et tester vos liens. Pour ce faire, générez (ou « compilez ») votre projet de façon à ce que vos changements les plus récents soient combinés en un format ou fichier visualisable (selon le format de projet). Une fois généré, visualisez (ou « exécutez ») le produit. Vous pouvez effectuer une génération à tout moment, autant de fois que vous le souhaitez.

À faire : Si vous ne l’avez pas encore fait, décidez du format de projet à utiliser. Le processus de génération est légèrement différent pour chaque format et supporte différentes fonctions au moment de l’exécution.

Introduction à la rédaction dans RoboHelp

Tester votre projet

Pour vérifier que l’aspect et le fonctionnement de votre projet sont conformes à vos souhaits et prévisions, vous devez le tester rigoureusement et périodiquement en le visualisant (l’exécutant) une fois généré. Si vous livrez un projet avec une application, installez et testez votre système avec l’application. L’important est que vos projets s’affichent sans erreur, que les liens affichent la destination correcte, que la mise en forme soit celle que vous souhaitez et que toutes les fonctions ajoutées fonctionnent correctement. Si vous avez des problèmes, résolvez-les dans le projet et effectuez de nouveau la génération. Avant de livrer votre projet, veillez à le tester sur différentes plates-formes et dans divers navigateurs.

À faire : Développez et suivez un plan de test méthodique afin de ne manquer aucun sujet, lien ou fonction lors du test. Demandez à d’autres personnes de lire votre contenu et de vérifier vos liens, dans la mesure du possible, pour qu’elles puissent repérer les erreurs que vous avez omises. Consultez le dossier Broken Links, exécutez des rapports de projet et utilisez les autres outils dont RoboHelp dispose pour le débogage.

Livrer le produit fini

Lorsque vous êtes satisfait de l’aspect et du fonctionnement de votre système, mettez votre produit à disposition des utilisateurs finaux. En fonction de votre situation, cela peut comprendre la publication des fichiers sur un serveur ou CD-ROM, la collaboration avec les développeurs pour installer le système avec une application ou l’utilisation d’une autre méthode de distribution.

À faire : Consultez l’aide en ligne de RoboHelp pour vous assurer que vous distribuez tous les fichiers nécessaires. Travaillez avec vos développeurs ou votre équipe Web pour intégrer le système à l’application, au serveur ou à d’autres fichiers à livrer.

Chapitre 2 Principes de base de rédaction

Fonctions supplémentaires pour votre projet

Lorsque vous êtes prêt à ajouter une navigation plus complexe, créer des éléments visuels et concevoir le look de vos sujets, jetez un coup d’œil à ces fonctions pour peaufiner votre projet.

Remarque : Ces fonctions sont disponibles selon le format de projet que vous

créez. Pour de plus amples informations, reportez-vous à l’aide en ligne de RoboHelp.

 Séquences d’exploration : Ajoutez ces liens pour que les utilisateurs

finaux puissent avancer et reculer dans une série de sujets ordrés.

 Élaborer des étiquettes : Utilisez l’élaboration d’étiquette pour contrôler

les sujets que les utilisateurs visualisent dans votre projet. Vous pouvez inclure ou exclure des sujets de votre produit fini tout en conservant tous les sujets dans le même projet.

 Sujets contextuels : Utilisez ces sujets pour fournir des renseignements

correspondant au contenu de l’écran affiché. Les utilisateurs accèdent généralement à ces renseignements en cliquant sur le bouton Help sur une boîte de dialogue ou en appuyant sur la touche F1.

 Liens de référence croisée : Ajoutez des boutons pour afficher une liste

de sujets connexes auxquels les utilisateurs peuvent accéder grâce à un lien intitulé Related Topics ou See Also.

 Fenêtres personnalisées : Créez des fenêtres personnalisées

(contiennent des sujets qui permettent aux utilisateurs de visualiser votre système) de tailles différentes ou s’affichant à des endroits différents de l’écran, en fonction du type de sujet affiché.

 Dynamic HTML : Ajoutez des objets qui réalisent une action, telle que du

texte qui se déroule quand l’utilisateur clique dessus ou du texte qui est surligné lorsque l’utilisateur fait glisser sa souris dessus.

 Recherche de texte : Permettez aux utilisateurs de rechercher des mots

utilisés dans le texte des sujets par le biais d’un champ Search.

 Glossaires : Fournissez une liste de termes et de définitions liés au sujet

traité dans votre projet.

 En-têtes et pieds de page : Utilisez les zones en haut et en bas des

sujets pour afficher des logos d’entreprise, l’heure et la date, des images, des tableaux et autres éléments que vous souhaitez placer à un endroit fixe.

 Images cliquables : Ajoutez des zones cliquables à vos images pour

afficher un autre sujet, URL, fenêtre indépendante ou autre destination.

Introduction à la rédaction dans RoboHelp

 Multimédia : Enrichissez votre projet de sons et clips vidéo pour illustrer

la réalisation de tâches ou l’utilisation de fonctions, fournir des instructions ou exécuter d’autres fonctions que vous découvrez.

 Liens indépendants : Utilisez des liens indépendants pour afficher une

fenêtre plus petite qui s’affiche sur la fenêtre principale. Ils sont particulièrement utiles si vous souhaitez fournir un lien vers des informations connexes mais éviter que l’utilisateur ait à revenir en arrière pour retrouver le sujet en cours.

 Rapports de projets : Gérez, effectuez un suivi et partagez des

informations concernant votre projet en utilisant divers rapports. Des renseignements concernant de nombreux éléments de votre projet sont disponibles dans des rapports de façon à ce que vous puissiez savoir de combien d’images vous disposez, s’il existe des fichiers inutilisés et bien d’autres choses encore.

 Profils : Personnalisez et actualisez votre produit pour qu’il s’intègre au

look de votre application en utilisant couleurs, polices et images sur vos barres d’outils, arrière-plans, boutons, icônes, etc.

 Feuilles de style : Contrôlez l’aspect de vos sujets et apportez des

modifications globales en une fois. Les sujets connectés aux feuilles de style sont automatiquement mis à jour pour refléter les modifications de mise en forme, vous permettant de travailler plus efficacement.

 Modèles de sujet : Utilisez des sujets spécialisés pour réutiliser les en-

têtes et pieds de page dans plusieurs sujets et donnez un look homogène à votre projet.

Gérer votre projet

La gestion d’un projet RoboHelp suit un processus semblable à celle d’autres types de projets. Faites appel à ces méthodes efficaces afin de vous assurer que votre projet répond bien à vos objectifs et exigences de qualité.

Définir le plan. Un plan communique vos attentes du projet et sert souvent à les partager avec le reste de votre équipe. Il définit le public ciblé, le but du projet ainsi que son contenu et sa conception. Un bon plan comprend aussi un moyen de mesurer l’efficacité du projet, y compris la manière de le tester. Si vous travaillez en équipe, il serait bon de clairement identifier les responsabilités et fonctions de chaque membre, et tout particulièrement pour les experts en la matière.

Pour élaborer un plan de projet et le distribuer, vous pouvez créer une table des matières dans RoboHelp, puis imprimer ou envoyer électroniquement un rapport de table des matières.

Chapitre 2 Principes de base de rédaction

Évaluer la quantité de travail. Avant de mettre en œuvre votre plan, vous devez savoir combien de temps votre projet va durer et connaître les ressources nécessaires. Vous devriez aussi connaître les ressources requises pour respecter l’échéance. Développez un plan pour suivre les progrès réalisés (moments de vérification) afin de bien gérer le calendrier de création. Dans RoboHelp, évaluez le temps de développement de chaque sujet dans Topic Properties (cliquez avec le bouton droit sur un sujet et sélectionnez

Properties).

Mettre en œuvre le plan. Commencez par développer et rédiger votre projet

en suivant votre plan. Créez le projet, rédigez les sujets et ajoutez des éléments tels que table des matières, liens et index. Générez le projet et testez-le pour vous assurer qu’il répond bien aux exigences de qualité et objectifs fixés. Une fois toutes les erreurs rectifiées, distribuez le système à vos utilisateurs finaux.

Évaluer le projet. Finalement, évaluez le résultat et le déroulement du processus. Avez-vous créé le projet dans les délais impartis, respecté le budget et utilisé les ressources qui y étaient affectées ? Quels sont les facteurs ayant influencé le processus de développement ? Qu’avez-vous appris ? Il peut s’agir d’une évaluation interne de votre processus de rédaction ou de commentaires provenant des membres de votre équipe ou de votre public. L’évaluation est une étape importante car elle vous permet de tirer parti de votre expérience et d’adapter votre processus.

Utilisation de RoboHelp pour gérer des projets

La gestion méticuleuse de votre projet est essentielle à la livraison d’un produit de qualité dans les délais impartis. Utilisez les conseils de gestion de projet dans la section précédente ainsi que les fonctions de ce programme pour parvenir à un processus fluide.

Utiliser des dossiers

L’onglet Project de RoboHelp sert à la visualisation et à la manipulation des fichiers de votre projet. Il affiche une hiérarchie de dossiers que vous pouvez développer ou réduire et qui rassemble sujets, images, feuilles de style et autres fichiers de projet en des groupes plus facilement gérés.

 Créez des dossiers pour organiser des sujets par groupe (par exemple,

créez un dossier pour les « Nouveaux comptes » et un sous-dossier pour les sujets de niveau dialogue ou contextuel pour Nouveaux comptes).

 Générez automatiquement votre table des matières en fonction de la

structure du dossier du projet. Si vous avez placez les sujets contextuels dans des sous-dossiers, vous pouvez les exclure de la table des matières au moment de la génération automatique.

Introduction à la rédaction dans RoboHelp

Utiliser des rapports

Les rapports vous proposent des statistiques concernant vos sujets, images, liens, index, table des matières, etc.

 Suivez les progrès de votre projet à l’aide du rapport Project Status ou le

rapport Topics by Priority.

 Isolez des problèmes pour les résoudre facilement à l’aide des rapports

Unreferenced Topics, Unused Files, Topic References ou Broken Links.

 Sauvegardez, modifiez, copiez, imprimez ou envoyez électroniquement des

rapports pour informer vos chefs ou collègues.

Utiliser l’état du sujet

Contrôlez l’état de chaque sujet et effectuez le suivi d’informations de niveau

sujet en cliquant sur

sur la barre d’outils et en sélectionnant l’onglet

Status.

 Maintenez une liste de choses « À faire » pour chaque sujet pour mieux

connaître les tâches que vous devez gérer.

 Mettez à jour l’état des sujets lors de la réalisation de chaque objectif

intermédiaire, à savoir en cours, prêt pour la révision et terminé.

 Affectez des priorités aux sujets pour que vous puissiez générer un rapport

Topics by Priority et prévoir le meilleur moyen d’organiser votre temps.

Chapitre 3

Didacticiel

Ce didacticiel rend l’apprentissage de RoboHelp HTML facile et agréable. Il est conçu pour les rédacteurs d’aide, rédacteurs techniques, spécialistes en documentation, développeurs Web, concepteurs pédagogiques et toute personne souhaitant proposer à des utilisateurs une excellente aide en ligne ou des systèmes de support de performance. À mesure que vous compléterez ces leçons, vous apprendrez à développer un projet qui affichera vos informations en ligne dans un navigateur ou un afficheur, avec une table des matières, un index ainsi que d’autres fonctions.

La Partie I explique les concepts de base concernant l’utilisation des fonctions essentielles de RoboHelp telles que la création de liens et de sujets. La Partie II propose des exercices pratiques utilisant des fonctions supplémentaires qui peuvent améliorer la conception et la fonctionnalité de vos projets, y compris l’ajout d’images et les séquences d’exploration.

Nous vous conseillons de suivre les leçons dans l’ordre de leur présentation, qui prendront environ deux à trois heures, selon votre niveau de connaissance de RoboHelp, expérience en matière de rédaction, etc.

Partie I −−−− Principes de base

Les leçons de la première partie servent d’introduction aux fonctions essentielles de RoboHelp. Une fois que vous les aurez complétées, vous serez en mesure de rédiger des sujets et concevoir un projet de base. Ce didacticiel contient un projet déjà créé à votre intention (vous n’aurez que très peu de saisie à effectuer dans la Partie I).

Dans la Partie I, vous apprendrez à réaliser les tâches suivantes dans RoboHelp :

 Ouvrir et sauvegarder un projet

 Ajouter des sujets

 Manipuler des dossiers

 Importer un fichier HTML

 Utiliser le vérificateur d’orthographe

 Créer une feuille de style

 Définir de nouveaux styles

Introduction à la rédaction dans RoboHelp

 Attacher une feuille de style à des sujets

 Appliquer des styles à des sujets

 Utiliser des styles incorporés et en ligne

 Ajouter et formater un tableau

 Afficher des sujets

 Créer des liens de base

 Créer des signets, liens de texte simple indépendants, liens indépendants

et liens Sujets connexes

 Visualiser et tester vos liens

 Créer automatiquement une table des matières (TOC)

 Ajouter un livre et des pages et les réorganiser dans la table des matières

 Visualiser le rapport de table des matières

Pour commencer

Les leçons suivantes vous permettront de commencer à utiliser RoboHelp.

Ouvrir un projet

Dans cette leçon, vous ouvrirez le projet didacticiel installé avec RoboHelp et vous apprendrez à connaître l’environnement de travail.

1 À partir de la barre des tâches de Windows (coin inférieur gauche de votre

bureau), cliquez sur :

Démarrer — Programmes — RoboHelp — RoboHelp HTML

Conseil : Vous pouvez aussi lancer le programme à partir de RoboHelp Starter :

1 Double-cliquez sur l’icône RoboHelp Starter située sur votre bureau.

2 Sélectionnez le menu Application, puis RoboHelp HTML.

+ 84 hidden pages