ADOBE RoboHelp Office X5 User Manual [fr]

Introduction à la rédaction dans RoboHelp

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.

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

www.ehelp.com

MARQUES DE FABRIQUE

1-Step RoboPDF, ActiveEdit, ActiveHelp, ActiveTest, Blue Sky, Blue Sky Software, CamStudio, Contents Tab Composer, eHelp, FlashHelp, HDF Editor, Help To HTML, Help-To-Source, HTML Help Studio, MenuBuilder, RoboDemo, RoboEngine, RoboFlash, RoboHelp, RoboHelp Office, RoboHTML, RoboInfo, RoboInsight, RoboLinker, RoboPDF, RoboScreenCapture, RoboSource Control, Smart Publishing Wizard, Software Video Camera, WebHelp, What’s This? Help Composer, WinHelp, WinHelp 2000, WinHelp BugHunter, WinHelp Find+, WinHelp Graphics Locator, WinHelp Hyperviewer, 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 aux États-Unis et/ou dans d'autres pays. Macromedia, HomeSite et Dreamweaver sont des marques de fabrique ou marques déposées de Macromedia Inc. aux États-Unis et dans d'autres pays. Adobe et FrameMaker sont soit des marques déposées soit des marques de fabrique de Adobe Systems Incorporated aux États-Unis et/ou dans d'autres pays. 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.

X5 Rév-01/04

Table des matières

chapter 1 Pour commencer ______________________________________ 1

Gamme de produits RoboHelp___________________________________________ 2 Ouverture et fermeture du programme____________________________________ 3 Création et ouverture de projets _________________________________________ 4 Environnements de rédaction RoboHelp Office ______________________________ 6

RoboHelp HTML ____________________________________________________ 6

RoboHelp for Word__________________________________________________ 8 Ressources utiles_____________________________________________________ 9 Contacter Macromedia________________________________________________ 11

Support technique _________________________________________________ 11

Service clientèle___________________________________________________ 12

Service de vente __________________________________________________ 12

Remarque sur la documentation ______________________________________ 13

chapter 2 Rédaction de base ____________________________________ 15

Types de produits ___________________________________________________ 15

Caractéristiques de base ____________________________________________ 16 Stratégies de développement d’un projet _________________________________ 17

Fonctions supplémentaires pour votre projet ____________________________ 22 Gérer votre projet ___________________________________________________ 23

Utilisation de RoboHelp pour gérer des projets ___________________________ 24

chapter 3 Didacticiel___________________________________________ 27

Partie I – Principes de base ____________________________________________ 28

Pour commencer __________________________________________________ 29

Changer l’apparence _______________________________________________ 42

Fournir des outils de navigation_______________________________________ 64 Partie II – Élaboration de votre projet ___________________________________ 81

Créer une table des matières_________________________________________ 82

Créer un index ____________________________________________________ 93

Travailler avec des images__________________________________________ 103

Introduction à la rédaction dans RoboHelp

Ajouter des séquences d’exploration __________________________________107 Personnaliser un produit grâce au texte conditionnel ______________________ 110 Utiliser les mises en forme source unique ______________________________ 113 Terminer le projet _________________________________________________118

Index _____________________________________________________ 121

Chapitre 1

Pour commencer

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 capacités source unique souples de RoboHelp sont conçues pour créer les produits suivants :

Q WebHelp : Aide basée sur le Web qui fonctionne sur presque toutes les

plates-formes et navigateurs les plus courants

Q WebHelp Pro : Aide basée sur serveur qui fournit des informations de

retour en temps réel de la part de vos utilisateurs sur votre aide et votre application

Q FlashHelp : Aide avec navigation basée sur Flash qui propose une

interface utilisateur dynamique et riche s'affichant normalement dans tous les navigateurs et plates-formes supportés

Q Microsoft HTML Help : Aide compilée basée sur HTML qui supporte les

versions Windows 98 et supérieures

Q JavaHelp : Aide basée sur Java développée par Sun Microsystems qui

fonctionne sur toute une gamme de plates-formes et nécessite JRE ou JDK

Q Oracle Help for Java : Aide basée sur Java développée par Oracle

Corporation qui fonctionne sur toute une gamme de plates-formes et nécessite JRE ou JDK

Q WinHelp : Aide pour les applications Windows de 16 ou 32 bits et l'aide

indépendante

Q Documentation imprimée : Documents Word créés à partir de vos sujets

en ligne, y compris table des matières, index et glossaire

Ce guide présente RoboHelp, conseille des stratégies élémentaires de développement et de gestion de projets d'aide et propose un didacticiel permettant d’apprendre à élaborer un projet d'aide 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 les éditions suivantes :

RoboHelp Office

RoboHelp Office propose des fonctions de navigation, organisation et indexation, de même que la possibilité de gérer des projets et de compiler, tester et déboguer efficacement des systèmes d'aide. Grâce aux deux outils de rédaction fournis avec RoboHelp Office (RoboHelp HTML et RoboHelp for Word), vous pouvez créer une multitude de produits différents à partir d'un seul projet, y compris WebHelp, FlashHelp, HTML Help et documentation imprimée. RoboHelp Office assure aussi une intégration à de nombreux outils courants, tels que Microsoft Word, Dreamweaver et FrontPage.

RoboHelp Office Pro

RoboHelp Office Pro fournit toutes les fonctionnalités primées de RoboHelp Office, plus d'autres fonctions telles que recherche en langue naturelle en anglais, recherche de textes intégraux pour dix langues supplémentaires et fusion de projet pour le développement en équipe.

RoboHelp Office Pro fournit en temps réel des informations de retour de la part de vos utilisateurs concernant votre aide et votre application à l'aide de technologie serveur. Vous pouvez visualiser plusieurs rapports vous indiquant les problèmes auxquels vos utilisateurs sont confrontés au niveau de votre système d'aide et de votre application ainsi que les domaines dans lesquels vous devez fournir davantage d'informations. Les résultats sont affichés dans un format graphique facile à visualiser, permettant une interprétation rapide. Votre produit WebHelp Pro est placé sur un serveur, rendant instantanée la mise à jour du contenu de votre système d'aide.

RoboHelp for Word

Utilisez RoboHelp for Word pour créer une aide pour des applications basées sur le Web ou de bureau, pour de nombreux produits différents, y compris WebHelp, FlashHelp, WinHelp et documentation imprimée. Servez-vous de cet outil si Microsoft Word est votre éditeur préféré ou si vous avez besoin de livrer un système d'aide pour des applications Windows à 16 ou 32 bits.

Chapitre 1 Pour commencer

Conseil : Pour obtenir des renseignements sur les nouveautés de RoboHelp, la

configuration système requise et l’installation et l'activation du programme, consultez le Guide d'installation RoboHelp Office fourni avec le CD-ROM du programme.

Ouverture et fermeture du programme

Une fois le programme installé, une icône RoboHelp 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, accéder à des annonces, forums d'utilisateurs et articles ou ouvrir les outils de productivité fournis avec RoboHelp.

RoboHelp Starter

Remarque : S'il s'agit de la première fois que vous lancez le programme, vous

devrez activer la clé de produit. Pour de plus amples informations, veuillez consulter le Guide d'installation RoboHelp Office qui accompagne votre CD-ROM de programme.

Introduction à la rédaction dans RoboHelp

Pour ouvrir RoboHelp Starter :

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

Appuyez sur F1 pour en savoir plus sur tout écran du Starter. Ou à partir du menu Aide, sélectionnez Contents & Index.

Pour fermer RoboHelp Starter :

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

Création et ouverture de projets

Utilisez ces procédures pour créer un projet ou ouvrir un projet existant à partir de RoboHelp Starter.

Remarque : S'il s'agit de la première fois que vous lancez le programme, vous

Pour créer un projet :

1 Double-cliquez sur l’icône RoboHelp

RoboHelp Starter s'ouvre.

2 Cliquez sur l'onglet New Project.

3 Sélectionnez le type de projet que vous voulez créer (tel que WebHelp).

Pour de plus amples informations sur chaque type, cliquez sur More info….

4 Lors du premier lancement du programme, il est possible qu'une boîte de

dialogue s’affiche vous demandant si vous souhaitez que RoboHelp HTML soit votre éditeur HTML par défaut. Cliquez sur Yes (vous pourrez modifier cette configuration ultérieurement si vous souhaitez sélectionner un éditeur différent).

Le New Project Wizard s'ouvre.

devrez activer la clé de produit. Pour de plus amples informations, veuillez consulter le Guide d'installation RoboHelp Office qui accompagne votre CD-ROM de programme.

située sur votre bureau.

Chapitre 1 Pour commencer

5 Dans Enter the title of this project, saisissez un titre de système d'aide

(que les utilisateurs verront dans l'afficheur ou navigateur). Ce titre reflète souvent le nom de l'application hôte du système d'aide.

Les autres options de cette boîte de dialogue sont renseignées par défaut. Pour obtenir de l'aide, appuyez sur F1.

6 Cliquez sur Finish. Le Starter se ferme et votre nouveau projet s'ouvre

dans RoboHelp.

Conseil : Par défaut, la fenêtre Starter se ferme dès que vous ouvrez un autre

Pour ouvrir un projet :

1 Double-cliquez sur l’icône RoboHelp

2 Cliquez sur l’onglet Open. Sous Project Files, une liste des fichiers

3 Double-cliquez sur le fichier que vous souhaitez ouvrir.

4 Le projet s’ouvre dans RoboHelp.

Conseil : Pour visualiser des exemples des fonctions RoboHelp, ouvrez les

programme ou outil à partir du Starter. Pour modifier ce paramètre, ouvrez le Starter et sélectionnez File-Auto-close RoboHelp Starter pour décocher la case située à côté de cette option.

située sur votre bureau.

RoboHelp Starter s'ouvre.

ouverts récemment s'affiche.

Si le fichier du projet ne figure pas dans la liste, double-cliquez sur More

Files pour rechercher un projet. Sélectionnez le fichier et cliquez sur Open.

projets types compris dans l'installation de RoboHelp qui se trouvent dans le sous-fichier Samples où RoboHelp Office est installé.

Introduction à la rédaction dans RoboHelp

Environnements de rédaction RoboHelp Office

RoboHelp Office comprend deux outils de rédaction dont les fonctionnalités sont similaires. L'outil que vous utiliserez dépendra de l'environnement de rédaction que vous préférez et des fonctions que vous souhaitez inclure dans votre système d'aide.

RoboHelp HTML

RoboHelp HTML offre un environnement de création souple mettant à votre disposition tout le nécessaire pour rédiger 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, inclure des effets spéciaux et ajouter bien d'autres fonctions. RoboHelp HTML est idéal pour créer des produits différents à partir d'un seul projet, y compris aide pour applications basées sur le Web, applications Windows de 32 bits, etc.

Avec RoboHelp HTML, 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. Développez une aide grâce à n'importe quel éditeur HTML courant, tel que Dreamweaver, FrontPage et HomeSite ou utilisez le puisant éditeur WYSIWYG intégré de RoboHelp HTML.

Environnement de travail de RoboHelp HTML

Chapitre 1 Pour commencer

Remarque : S'il s'agit de la première fois que vous lancez le programme, vous

devrez activer la clé de produit. Pour de plus amples informations, veuillez consulter le Guide d'installation RoboHelp Office qui accompagne votre CD-ROM de programme.

Pour ouvrir RoboHelp HTML :

1 Double-cliquez sur l’icône RoboHelp

située sur votre bureau.

RoboHelp Starter s'ouvre.

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

3 Lors du premier lancement du programme, une boîte de dialogue s’affiche

vous demandant si vous souhaitez que RoboHelp HTML soit votre éditeur HTML par défaut. Cliquez sur Yes (vous pourrez modifier cette configuration ultérieurement si vous souhaitez sélectionner un éditeur différent).

4 Dans la boîte de dialogue qui s'affiche, procédez d'une des manières

suivantes :

 Sous More Files, sélectionnez un nom de projet et cliquez sur OK.

 Double-cliquez sur More Files pour rechercher un projet puis cliquez

sur Open.

 Cliquez sur Create a new project pour créer un projet (pour de plus

amples informations, appuyez sur F1 dans n'importe quelle boîte de dialogue).

Pour des informations complètes sur l’utilisation de RoboHelp HTML, reportezvous à l’aide en ligne (ouvrez le programme, sélectionnez le menu Help puis Contents & Index). Utilisez les boutons Contents, Index et Search pour trouver les renseignements dont vous avez besoin. Vous pouvez aussi suivre le didacticiel du Chapitre 3 de ce manuel pour vous familiariser avec le programme.

Introduction à la rédaction dans RoboHelp

RoboHelp for Word

RoboHelp for Word utilise Microsoft Word comme éditeur pour que vous puissiez rédiger et modifier vos sujets d'aide dans un environnement familier. Utilisez RoboHelp for Word pour organiser et gérer vos fichiers source, obtenir une représentation visuelle des liens de votre sujet et concevoir rapidement une table des matières, des séquences de navigation, un index, etc.

RoboHelp for Word est l'outil idéal pour créer des produits différents à partir d'un seul projet, y compris aide pour applications Windows de 16 ou 32 bits et applications basées sur le Web. Vous pouvez aussi importer et manipuler des projets d'aide créés par le biais d'autres outils de rédaction.

Environnement de travail RoboHelp for Word

Chapitre 1 Pour commencer

Remarque : S'il s'agit de la première fois que vous lancez le programme, vous

Pour ouvrir RoboHelp for Word :

1 Double-cliquez sur l’icône RoboHelp

RoboHelp Starter s'ouvre.

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

3 Dans la boîte de dialogue qui s'affiche, procédez d'une des manières

suivantes :

 Sous More Files, sélectionnez un nom de projet et cliquez sur OK.

 Double-cliquez sur More Files pour rechercher un projet puis cliquez

 Cliquez sur Create a new project pour créer un projet (pour de plus

Pour de plus amples informations sur l’utilisation de RoboHelp for Word, reportez-vous à l’aide en ligne (ouvrez le programme, sélectionnez le menu Help, puis Contents & Index). Utilisez les onglets Contents, Index et Search pour trouver les renseignements dont vous avez besoin.

devrez activer la clé de produit. Pour de plus amples informations, veuillez consulter le Guide d'installation RoboHelp Office qui accompagne votre CD-ROM de programme.

située sur votre bureau.

sur Open.

amples informations, appuyez sur F1 dans n'importe quelle boîte de dialogue).

Ressources utiles

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

Q 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 for Word, ouvrez le programme concerné, sélectionnez le menu Help, puis Contents & Index.

Le système d'aide en ligne de RoboHelp HTML utilise WebHelp Pro comme produit. Étant donné que le système d'aide est appelé depuis un serveur, la rapidité d'affichage du système dépend de la vitesse de votre connexion Internet. Au besoin, vous pouvez sélectionner une option pour visualiser le système d'aide RoboHelp HTML hors ligne plutôt qu'à partir du serveur (cette fonction est appelée « Airplane Help »). Pour sélectionner cette option, ouvrez RoboHelp HTML. À partir du menu Tools, sélectionnez Options. Sur l'onglet General, sélectionnez Use Offline Help.

Introduction à la rédaction dans RoboHelp

Q 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 Macromedia. Apprenez des astuces sur les 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 www.helpcommunity.ehelp.com/ ou dans RoboHelp Starter, sélectionnez le menu Help, puis Help Community Web Site.

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

indiquant la manière de créer un projet d'aide. Ce didacticiel est divertissant et représente un moyen facile d'apprendre à connaître RoboHelp HTML et de découvrir les fonctions que vous pouvez ajouter à votre projet.

Le didacticiel est aussi disponible en ligne (dans la fenêtre RoboHelp Starter, sélectionnez le menu Help, puis RoboHelp HTML Tutorial).

Q Aide au niveau de la fenêtre : Dans presque toutes les boîtes de

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

Chapitre 1 Pour commencer

Contacter Macromedia

Le bureau Macromedia - San Diego crée la gamme de produits RoboHelp.

Adresse :

Téléphone : 1-858-847-7400

Fax : 1-858-847-1415

World Wide Web : www.ehelp.com

Heures d’ouverture :

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

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

Support technique

Macromedia 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 Macromedia dépendent du prix et des

Q 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

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

Q 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 Macromedia :

www.helpcommunity.ehelp.com

Q 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

Q 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.

Introduction à la rédaction dans RoboHelp

Service clientèle

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

Téléphone : 1-800-677-4946 World Wide Web : www.ehelp.com/support/customercare.asp Email : customer.care@ehelp.com

Service de vente

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

Téléphone – Service de vente :

International (Canada compris) :

Fax – Service de vente : 1-858-847-1416 World Wide Web : www.ehelp.com Email – Service de vente :* sales@ehelp.com Heures d’ouverture : Du lundi au vendredi

*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.

1-800-677-4946

1-858-847-7900

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

Chapitre 1 Pour commencer

Remarque sur la documentation

Macromedia 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 :

Q Nom du produit et numéro de version

Q Manuel imprimé ou aide en ligne

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

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

Q 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.)

Q 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

Rédaction de base

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 d'aide et gérer votre projet.

RoboHelp vous offre la flexibilité nécessaire pour créer des systèmes d'aide en utilisant les méthodes qui vous correspondent le mieux. À mesure que vous développez votre projet, vous découvrirez d’autres façons encore d’augmenter votre efficacité afin de créer un produit répondant entièrement aux besoins de vos utilisateurs.

Types de produits

L'un des aspects les plus importants du développement d'aide consiste à déterminer le type de produit que vous avez besoin de créer. Le produit représente les fichiers que vous proposez à vos utilisateurs finaux. Vous devez prendre en compte les plates-formes et afficheurs requis pour votre application hôte, les fonctions que chaque produit supporte ainsi que vos objectifs. Par exemple, certains utilisateurs peuvent ne posséder qu'un seul navigateur sur leur système – votre système d'aide s'affichera-t-il correctement pour eux ? Par ailleurs, votre application hôte fonctionne probablement sur un type précis de plate-forme et vos fichiers d'aide devront donc être compatibles avec elle.

Ces détails 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 produits (aussi appelés types de projet ou formats d'aide) permettent de résoudre ces problèmes en fournissant divers types de supports et de fonctions.

Dans RoboHelp, vous pouvez créer des fichiers de produit qui fonctionnent sur divers afficheurs et plates-formes, supportent des fonctions spécifiques et affichent des interfaces diverses. Ces différences peuvent sembler subtiles aux utilisateurs mais les auteurs doivent être pleinement conscients des caractéristiques des produits qu’ils créent.

Introduction à la rédaction dans RoboHelp

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 produit 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, un produit qui fonctionne sur des platesformes multiples et ne dépend pas d’un navigateur donné. Si vous souhaitez fusionner des projets sur un serveur Web et accéder en temps-réel aux rapports d'informations de retour concernant l'utilisation de votre système, vous pouvez choisir WebHelp Pro comme produit, car il est basé sur serveur. Tel qu'expliqué dans le Chapitre 1, RoboHelp propose différents produits, selon l'édition que vous achetez.

Pour de plus amples informations sur la manière de sélectionner un produit, vous pouvez utiliser la visite guidée proposée dans RoboHelp Starter. Doublecliquez 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é en haut de la fenêtre Starter.

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 produits, ils présentent aussi certaines similitudes. Ci-dessous figurent quelques fonctions universelles :

Q Navigation graphique et support d’organisation (par exemple, liens, index

multi-niveaux et tables des matières)

Q Sujets indépendants (liens qui ouvrent un sujet dans une petite fenêtre) Q 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).

Q Références croisées intitulées Related topics ou See Also (listes de liens

avec d'autres sujets contenant des sujets connexes)

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

chercher un texte au sein du contenu de sujets)

Q Aide contextuelle (sujets fournissant des renseignements correspondant au

contenu de l’écran affiché)

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

Chapitre 2 Rédaction de base

Stratégies de développement d’un projet

Ci-dessous, vous trouverez une stratégie conseillée de développement de projet d'aide 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 aide. Chaque tâche comprend des éléments conseillés (« À faire ») avant de commencer.

Q Créer un projet Q Ajouter des sujets Q Ajouter un contenu Q Développer une table des matières Q Créer des liens Q Insérer des images Q Construire un index Q Générer et visualiser votre projet Q Tester votre projet Q Livrer le produit fini

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

ligne de RoboHelp (ouvrez le programme, sélectionnez le menu Help puis Contents & Index). Pour apprendre à créer un projet de bout en bout, reportez-vous au didacticiel du Chapitre 3.

Introduction à la rédaction dans RoboHelp

Créer un projet

Les projets RoboHelp vous permettent de gérer et d'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. Une fois que vous avez ajouté des sujets (voir l'étape suivante), vous pouvez créer des dossiers dans Project Manager pour organiser vos informations et ajouter une structure à votre projet. Reportezvous 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 disposent car cela affectera le genre de fonctions disponibles dans votre projet ainsi que la manière de le livrer. Ensuite, consultez l’aide en ligne de RoboHelp pour connaître les fonctions que chaque produit 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 créez un chemin d'accès (navigation) pour qu'ils soient faciles à trouver (voir « Créer des liens » ultérieurement dans cette section). Vous pouvez ajouter des sujets dès que vous avez créé le projet ou à mesure que vous progressez, selon 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.

Ajouter un contenu

Pour ajouter du texte à vos sujets dans RoboHelp, la méthode est semblable à la rédaction d'un manuel, 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 n'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.

Chapitre 2 Rédaction de base

À faire : Déterminez les types d’information que vous voulez ajouter (présentation, processus, contexte, référence, etc.) et la manière de les présenter. Par exemple, dans chaque sujet de processus, vous pouvez inclure une brève description du processus en haut, les étapes sous forme de liste numérotée et une image de l’interface utilisateur que vous décrivez. Par ailleurs, assurez-vous d'instaurer un processus complet de révision pour que votre contenu soit correct, sans erreur et utilisable.

Développer une table des matières

Une table des matières (TOC) permet aux utilisateurs non seulement d'accéder à des informations, mais aussi de consulter une vue hiérarchique de vos sujets et de trouver les sujets 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 seront-ils 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.

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 réaliserez-vous des 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 ne se perdent dans votre système ?

Introduction à la rédaction dans RoboHelp

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 ?

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 de RoboHelp qui vous permettra de créer rapidement un index en fonction des mots et phrases de vos sujets.

Les index nécessitent généralement plus de temps et d'effort que prévu ; n'oubliez pas d'inclure du temps pour le contrôle de qualité et autres tests. De cette manière, vous vous assurez que l’index est complet, exact et affiche les sujets correspondant aux entrées cliquées. L'index est souvent le premier endroit que les utilisateurs consultent lorsqu'ils ont besoin d'aide, alors consacrez suffisamment de temps à son développement.

À 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 et 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 visualiser votre projet

Pendant le développement d’un projet, vous devriez examiner votre système du point de vue d’un utilisateur final ainsi que 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 produit). Une fois généré, RoboHelp vous offre la possibilité de visualiser le produit. Vous pouvez effectuer une génération à tout moment, autant de fois que nécessaire.

À faire : Si vous ne l’avez pas encore fait, décidez du produit à 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.

Chapitre 2 Rédaction de base

Tester votre projet

Pour vous assurer que le système se présente et réagit comme prévu, vous devez le tester de manière approfondie. Testez votre projet régulièrement en le visualisant (l'exécutant) une fois qu'il est 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 CDROM, 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.

Introduction à la rédaction dans RoboHelp

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 aux fonctions suivantes pour peaufiner votre projet.

Remarque : Ces fonctions sont disponibles selon le produit que vous créez.

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

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

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

Q Texte conditionnel : Le texte conditionnel vous permet de personnaliser

votre produit de façon à créer plusieurs versions à partir d'un même projet. Vous pouvez marquer le contenu pour qu'il soit utilisé dans des produits spécifiques tels que documents imprimés, une version d'un système d'aide pour les experts et pour les débutants, un didacticiel ou une version d'évaluation. Marquez des sujets entiers ou uniquement des parties de sujets (blocs de texte et images) à exclure du produit.

Q Aide contextuelle : Travaillez en collaboration avec vos développeurs

pour afficher les sujets fournissant 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.

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

de sujets connexes auxquels les utilisateurs peuvent accéder. Ces liens sont appelés liens Related Topics ou liens See Also.

Q Fenêtres personnalisées : Dans certains produits, vous pouvez créer des

fenêtres personnalisées (contenant 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 présenté.

Q 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. Disponible dans RoboHelp HTML

Q Recherche de texte : Permettez aux utilisateurs de rechercher un texte

utilisé dans des sujets par le biais d'un champ Search.

Q Glossaire : Dans certains produits, vous pouvez fournir une liste de termes

et de définitions liés au sujet traité dans votre projet.

Chapitre 2 Rédaction de base

Q 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. Disponible dans RoboHelp HTML.

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

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

Q 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 dont vous avez besoin. Utilisez des films RoboDemo pour créer des petits didacticiels interactifs directement à partir de RoboHelp ou insérez des films RoboDemo dans vos sujets. (RoboDemo est vendu séparément. Pour de plus amples informations, veuillez contacter le Service de vente Macromedia.)

Q 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 n'ait à revenir en arrière pour retrouver le sujet en cours.

Q Rapports de projets : Gérez des informations concernant votre projet ,

effectuez-en le suivi et partagez-les 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.

Q Profils : Dans certains produits, vous pouvez personnaliser et actualiser

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.

Q Styles : Contrôlez l’aspect de vos sujets et apportez des modifications

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

Q 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 à vos sujets. Disponible dans RoboHelp HTML.

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 prouvées et efficaces afin de vous assurer que votre projet répond bien à vos objectifs et exigences de qualité.

Introduction à la rédaction dans RoboHelp

Définir un 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.

É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, séquence d'exploration et index.

Tester, tester, tester ! Une des étapes les plus importantes dans la gestion de votre projet consiste à le tester. Testez vos liens et zones cliquables pour vous assurer qu'ils vous mènent à la destination correcte, vérifiez votre mise en forme pour veiller à son uniformité, testez votre aide contextuelle pour vérifier que le sujet adéquat s'affiche, suivez toutes vos séquences d'exploration pour vous assurer que vous n'avez oublié aucun sujet et testez les autres fonctions que vous avez utilisées. Lorsque le système ne possède plus d'erreurs, distribuez le produit généré à vos utilisateurs.

É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 qui 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.

Chapitre 2 Rédaction de base

Utiliser des dossiers

Le Project Manager dans RoboHelp sert à la visualisation et à la manipulation des fichiers de votre projet (pour y accéder, cliquez sur l'onglet Project dans le coin inférieur gauche de la fenêtre du programme). Le Project Manager affiche une hiérarchie de dossiers que vous pouvez développer ou réduire et qui rassemble des fichiers de projet en des groupes plus facilement gérés.

Q Créez des dossiers ou documents pour organiser des sujets par groupe (par

exemple, créez un dossier pour « Setup » et un sous-dossier pour les sujets de niveau dialogue ou des sujets contextuels pour « Setup »).

Q Créez automatiquement votre table des matières en fonction de la structure

du dossier du projet. Si vous avez placé 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.

Utiliser des rapports

Les rapports vous proposent des statistiques concernant vos sujets, images, liens, index, table des matières, etc. Pour accéder aux rapports, cliquez sur le menu Tools, puis sélectionnez Reports. Sélectionnez un rapport dans le sousmenu.

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

rapport Topics by Priority.

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

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

Q 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 au niveau du

sujet en cliquant sur Properties l’onglet Status.

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

garder à l'esprit les tâches que vous devez gérer.

Q 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é.

Q 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.

sur la barre d’outils et en sélectionnant

Introduction à la rédaction dans RoboHelp

Utiliser le contrôle de version

Le contrôle de version sauvegarde votre travail en cours, conserve des versions antérieures de vos fichiers et stocke les fichiers dans un lieu sûr. Si pour une raison quelconque vous perdez un fichier ou un fichier est corrompu, vous pouvez retrouver une version antérieure du fichier à partir du contrôle de version. La plupart des logiciels de contrôle de version affichent les historiques de fichier, permettent de partager les fichiers, de les organiser, etc.

Q Vous pouvez être sûr que personne n'est en train de modifier un fichier

lorsque vous le stocker dans le contrôle de version car seul une personne à la fois peut « sortir » le fichier, le rendant disponible en lecture uniquement aux autres utilisateurs. De cette manière, tous les membres d'une équipe peuvent partager un projet et des fichiers sans écraser le travail de leurs collègues.

Q Du moment que chaque auteur utilise la même base de données de

contrôle de version, tous les membres d'une équipe peuvent voir les modifications que chacun apporte au projet. Vous pouvez visualiser les changements qui sont réalisés par d'autres utilisateurs en « obtenant » les fichiers du contrôle de version.

Q Utilisez aussi le contrôle de version pour les projets à utilisateur unique.

Tout projet peut bénéficier de sa centralisation dans un dispositif de réseau en vue d'être sauvegardé avec le reste des données de votre organisation.

Pour utiliser le contrôle de version avec RoboHelp HTML, vous devez avoir installé un contrôle de version qui supporte l'API SCC* de Microsoft, tel que Microsoft Visual SourceSafe. Vous disposez de deux options : Vous pouvez utiliser RoboSource Control, le logiciel de contrôle de version que vous pouvez installer avec RoboHelp Office ou vous pouvez utiliser un contrôle de version tiers que votre département utilise peut-être déjà (et qui supporte l'API SCC de Microsoft). Peu importe l'option sélectionnée, vous n'êtes pas obligé de quitter RoboHelp HTML pour rentrer ou sortir des fichiers ou réaliser d'autres tâches de contrôle de version courantes. Reportez-vous à l'aide en ligne RoboHelp HTML pour des explications complètes.

*Microsoft Common Source Code Control (SCC). Contactez votre administrateur pour vérifier que votre contrôle de version y est conforme.

+ 100 hidden pages