Flux de travaux de publication HTML utilisant Technical Communications Suite et des produits autonomes

Sources mixtes de documents
Paramètres de conversion de projet
Conseils pour créer l’aide contextuelle
- Scénarios de création d’un projet
- Scénarios de mise à jour d’un projet RoboHelp

Adobe Technical Communications Suite fournit aux spécialistes en communication technique un processus rationnel qui leur permet de créer du contenu de façon unique et de le diffuser dans plusieurs formats. Vous pouvez créer du contenu dans FrameMaker et importer des documents FrameMaker dans RoboHelp pour publier l’aide dans plusieurs formats, y compris l’aide Adobe AIR et WebHelp.

La suite offre plus de fonctions que les différentes applications qu’elle inclut utilisées comme produits autonomes. Le tableau ci-dessous répertorie les différences de flux de travaux concernant l’importation de documents FrameMaker lorsque vous utilisez la suite et lorsque vous utilisez les produits autonomes.

Tâche dans le flux de travaux	Technical Communication Suite	FrameMaker et RoboHelp en tant qu’applications autonomes
Importation de documents FrameMaker dans le projet RoboHelp	Liez ou importez les documents FrameMaker source dans le projet RoboHelp.	Importez les documents FrameMaker.
Synchronisation des fichiers FrameMaker source et des rubriques RoboHelp	Le conteneur Gestionnaire de projets de RoboHelp indique si les documents liés ne sont pas synchronisés. Vous pouvez mettre à jour les documents liés pour que les modifications soient prises en compte dans les projets RoboHelp. Vous pouvez choisir de conserver les modifications dans les rubriques générées.	Réimportez les documents FrameMaker et remplacez les rubriques générées précédemment.
Mise à jour de la structure des rubriques lorsque les paramètres de pagination sont modifiés	Mettez à jour le document FrameMaker dans RoboHelp.	Réimportez les documents FrameMaker et remplacez les rubriques générées précédemment.

Sources mixtes de documents

En règle générale, le flux de travaux de la suite vous permet de convertir vos livres FrameMaker existants au format d’aide en ligne, c’est-à-dire que vous liez l’ensemble du livre dans RoboHelp. Si vos documents FrameMaker sont valides, vous pouvez optimiser le flux de travaux en modifiant de façon minimale la source FrameMaker ou les rubriques générées dans RoboHelp. Utilisez cette méthode lorsque vous créez du contenu principalement dans FrameMaker et que vous souhaitez utiliser RoboHelp comme outil de publication.

Toutefois, il est parfois nécessaire de réutiliser du contenu provenant de sources diverses dans les projets RoboHelp. Cela est le cas lorsque vous mettez à jour un projet d’aide en ligne de petite envergure en incluant des informations conceptuelles à partir d’un guide de référence et des informations de dépannage à partir d’un guide de maintenance. Ces documents peuvent être créés dans différents outils et modèles, et ils suivent peut-être des règles de rédaction différentes.

Les documents peuvent avoir les sources suivantes, entre autres :

Documents créés dans des versions antérieures de FrameMaker
Documents créés dans FrameMaker structuré et non structuré
Documents créés dans FrameMaker et dans Microsoft Word

Paramètres de conversion de projet

RoboHelp vous permet de définir des paramètres de projet pour chaque type de source. Pour tous les documents FrameMaker, vous ne définissez les paramètres de conversion qu’une seule fois, qu’ils soient liés ou importés dans RoboHelp. De même, les paramètres de conversion des documents Microsoft Word restent les mêmes pour les documents liés, comme pour les documents importés.

Les paramètres de conversion de projet garantissent la cohérence non seulement dans votre projet, mais également sur plusieurs projets. Vous pouvez configurer un projet RoboHelp rapidement sans avoir à définir de paramètres de conversion pour les paragraphes, les tableaux, les images, etc.

Les paramètres de conversion de projet sont mieux adaptés lorsque vous créez l’ensemble du document dans FrameMaker ou dans Word, puis utilisez RoboHelp comme outil de publication. Dans ce cas, vous devez simplement optimiser le contenu source pour la publication aux formats d’aide en ligne et ne pas modifier (ou peu) le contenu dans RoboHelp. Cependant, si votre environnement de création est mixte ou si le contenu provient de plusieurs sources, les scénarios deviennent plus complexes. Des différences dans les éléments suivants peuvent ajouter à la complexité :

Modèles FrameMaker: RoboHelp vous permet de sélectionner le modèle à appliquer aux documents FrameMaker que vous liez ou importez. Différents types de document peuvent avoir différents modèles avec différents formats de paragraphe définis.
Modèles de désignation des rubriques: Ce facteur de complexité intervient lorsque vous basez les noms des rubriques sur le texte du paragraphe. Selon la façon dont vous avez rédigé les titres, les noms des rubriques RoboHelp peuvent ne pas être cohérents. Pour les documents FrameMaker, vous pouvez définir la désignation des rubriques en fonction des marqueurs personnalisés. Vous ne pouvez pas définir la désignation des rubriques en fonction des marqueurs personnalisés dans Word.
Texte du marqueur d’aide contextuelle: Si vous définissez l’aide contextuelle directement dans les documents source, vous contrôlez entièrement la façon dont l’aide en ligne est créée. Toutefois, définir la contextualité dans la source risque d’introduire une certaine complexité. Si vous disposez de plusieurs types de documents source, vous possédez généralement plusieurs types de marqueurs dont la syntaxe est différente.

Conseils pour créer l’aide contextuelle

Pour surmonter ces difficultés, gardez ces conseils à l’esprit lorsque vous planifiez un projet :

Déterminer le flux de travaux: Si vous travaillez sur un grand projet créé à l’origine dans RoboHelp, il est plus logique de poursuivre la création dans RoboHelp, si le contenu saisi est minimal. La liaison et l’importation de documents externes risquent d’augmenter la complexité du projet, en particulier si vous avez défini des tables des matières, des index, des glossaires et des paramètres d’aide contextuelle dans RoboHelp. En revanche, si vous créez un projet entièrement nouveau ou modifiez de façon significative un projet existant, vous devez lier et importer les documents externes pour ne pas avoir à mettre à jour manuellement le contenu dans RoboHelp.
Identifier les documents source: Avant de définir les paramètres du projet dans RoboHelp, identifiez les sources de contenu que vous avez l’intention d’utiliser dans votre projet. Si tous vos documents source sont des documents FrameMaker valides, liez les documents. Si vos documents source sont de types différents, importez les documents.
Examiner les options de liaison et d’importation: Même si vous pouvez choisir de convertir la table des matières, l’index et le glossaire à partir des documents source, examinez attentivement vos options. Par exemple, l’importation d’une table des matières est recommandée si vous souhaitez conserver la structure de la table des matières dans vos documents source. De même, si vous importez un ensemble de documents FrameMaker et Word dans des versions différentes, réfléchissez avant d’utiliser des marqueurs d’aide contextuelle ou des marqueurs d’index. Leur utilisation ne présente un avantage que si vous apportez des modifications importantes. Si la mise à jour est minime, il est parfois préférable d’importer le contenu et d’ajouter les ID de mappage ou les entrées d’index de façon native dans RoboHelp.

Scénarios de création d’un projet

Documents source	Méthode à utiliser	Options disponibles
Livre FrameMaker structuré ou non structuré unique	Lier le livre FrameMaker	Utilisez RoboHelp comme outil de publication, lorsque le contenu à créer dans RoboHelp est minimal ou inexistant. Définissez la pagination en fonction des formats de paragraphe FrameMaker ou des marqueurs personnalisés. Créez un système d’aide contextuelle à l’aide des marqueurs personnalisés dans FrameMaker. Convertissez la table des matières, l’index et le glossaire.
Plusieurs livres FrameMaker structurés ou non structurés	Lier les livres FrameMaker	Utilisez RoboHelp comme outil de publication, lorsque le contenu à créer dans RoboHelp est minimal ou inexistant. Définissez la pagination en fonction des formats de paragraphe FrameMaker ou des marqueurs personnalisés. Créez un système d’aide contextuelle à l’aide des marqueurs personnalisés dans FrameMaker. Convertissez la table des matières, l’index et le glossaire.
Un ou plusieurs livres FrameMaker dans des versions antérieures à la version 7	Importer les livres FrameMaker	Définissez la pagination en fonction des formats de paragraphe FrameMaker ou des marqueurs personnalisés. Créez un système d’aide contextuelle à l’aide des marqueurs personnalisés dans FrameMaker. Convertissez la table des matières, l’index et le glossaire.
Documents FrameMaker indépendants	Importer les documents FrameMaker	Définissez la pagination en fonction des formats de paragraphe FrameMaker ou des marqueurs personnalisés. Convertissez la table des matières, l’index et le glossaire.
Document Word unique avec une table des matières et un index valides	Lier le document Word	Définissez la pagination en fonction des styles de paragraphe Word. Définissez le marqueur d’aide contextuelle à l’aide de l’option de note de bas de page personnalisée de Word et utilisez le texte du marqueur pour l’aide contextuelle. Convertissez la table des matières, l’index et le glossaire. Utilisez RoboHelp comme outil de publication, lorsque le contenu à créer dans RoboHelp est minimal ou inexistant.
Plusieurs documents Word	Importer les documents	Définissez la pagination en fonction des styles de paragraphe Word. Définissez le marqueur d’aide contextuelle à l’aide de l’option de note de bas de page personnalisée de Word et utilisez le texte du marqueur pour l’aide contextuelle.
Mélange de livres FrameMaker et de documents Word	Lier les documents FrameMaker et Word	Définissez la pagination en fonction des styles de paragraphe FrameMaker et Word, séparément. Utilisez le marqueur d’aide contextuelle dans les documents source.
Mélange de documents FrameMaker et Word indépendants	Importer les documents	Définissez la pagination en fonction des styles de paragraphe FrameMaker et Word, séparément. Utilisez le marqueur d’aide contextuelle dans les documents source.

Scénarios de mise à jour d’un projet RoboHelp

Documents source	Méthode à utiliser	Options disponibles
Livre FrameMaker structuré ou non structuré unique	Lier le livre FrameMaker	Définissez la pagination en fonction des formats de paragraphe FrameMaker ou des marqueurs personnalisés. Créez un système d’aide contextuelle à l’aide des marqueurs personnalisés dans FrameMaker.
Plusieurs livres FrameMaker structurés ou non structurés	Lier les livres FrameMaker	Définissez la pagination en fonction des formats de paragraphe FrameMaker ou des marqueurs personnalisés.
Plusieurs livres FrameMaker ou documents FrameMaker indépendants	Importer les livres et les documents FrameMaker	Définissez la pagination en fonction des formats de paragraphe FrameMaker ou des marqueurs personnalisés.
Document Word unique avec une table des matières et un index valides	Lier le document Word	Définissez la pagination en fonction des styles de paragraphe Word.
Plusieurs documents Word	Importer les documents	Définissez la pagination en fonction des styles de paragraphe Word.
Mélange de documents FrameMaker et Word indépendants	Importer les documents	Définissez la pagination en fonction des styles de paragraphe FrameMaker et Word, séparément.