|
Die Adobe Technical Communications Suite optimiert den Arbeitsablauf zur Erstellung von technischer Dokumentation. Inhalte müssen nur einmal geschrieben werden und lassen sich danach in zahlreichen Formaten bereitstellen. Sie können Dokumente in FrameMaker erstellen, in RoboHelp importieren und in mehreren Hilfeformaten (z. B. Adobe AIR-Hilfe und WebHelp) veröffentlichen.
Die Anwendungen der Suite bieten mehr Funktionen als die entsprechenden eigenständigen Produkte. In der folgenden Tabelle werden einige Unterschiede aufgeführt, die sich hinsichtlich des Arbeitsablaufs bei Suite- und eigenständigen Produkten ergeben.
Aufgabe im Arbeitsablauf
|
Technical Communication Suite
|
FrameMaker und RoboHelp als eigenständige Produkte
|
|---|
Importieren von FrameMaker-Dokumenten in ein RoboHelp-Projekt
|
FrameMaker-Quelldokumente können mit dem RoboHelp-Projekt verknüpft oder importiert werden.
|
FrameMaker-Dokumente können nur importiert werden.
|
Synchronisieren von FrameMaker-Quelldateien und RoboHelp-Themen
|
Der Projektmanager-Pod in RoboHelp zeigt an, ob verknüpfte Dokumente synchron sind. Sie können die verknüpften Dokumente aktualisieren, um die Änderungen in die RoboHelp-Projekte aufzunehmen. Sie können die Änderungen in den generierten Themen beibehalten.
|
FrameMaker-Dokumente müssen neu importiert und die zuvor generierten Themen überschrieben werden.
|
Aktualisieren der Themenstruktur nach Änderung der Seitenumbrucheinstellungen
|
Aktualisieren Sie das FrameMaker-Dokument in RoboHelp.
|
FrameMaker-Dokumente müssen neu importiert und die zuvor generierten Themen überschrieben werden.
|
Dokumente aus verschiedenen QuellenIn der Regel verwenden Sie den Suite-Arbeitsablauf, um vorhandene FrameMaker-Bücher in das Onlinehilfeformat zu konvertieren, d. h., Sie verknüpfen das ganze Buch mit RoboHelp. Bei ordnungsgemäß formatierten FrameMaker-Dokumenten kann der Arbeitsablauf so optimiert werden, dass nur geringfügige Änderungen an der FrameMaker-Quelle oder den generierten RoboHelp-Themen erforderlich sind. Diese Methode ist sinnvoll, wenn Sie die Inhalte hauptsächlich in FrameMaker erstellen und RoboHelp zum Veröffentlichen verwenden.
Eventuell müssen Sie in RoboHelp-Projekte jedoch Inhalte aus verschiedenen Quellen integrieren. Ein Beispiel dafür ist die Aktualisierung eines kleinen Onlinehilfeprojekts, um Begriffsdefinitionen aus einem Referenzhandbuch und Fehlerbehebungsinformationen aus einem Wartungshandbuch aufzunehmen. Diese Dokumente wurden möglicherweise in anderen Programmen, mit anderen Vorlagen und Stilrichtlinien geschrieben.
Dokumente können beispielsweise aus folgenden Quellen stammen:
Frühere FrameMaker-Versionen
Strukturierte und unstrukturierte FrameMaker-Versionen
FrameMaker- und Microsoft Word-Dokumente
Projektweite KonvertierungseinstellungenIn RoboHelp können Sie projektweite Einstellungen für jeden Quelldokumenttyp definieren. Für FrameMaker-Dokumente müssen Sie die Konvertierungseinstellungen nur einmal festlegen, unabhängig davon, ob diese in RoboHelp importiert oder verknüpft werden. Entsprechend werden für verknüpfte und importierte Microsoft Word-Dokumente identische Konvertierungseinstellungen verwendet.
Projektweite Konvertierungseinstellungen sorgen nicht nur innerhalb des Projekts für Konsistenz, sondern auch über mehrere Projekte hinweg. RoboHelp-Projekte lassen sich schnell einrichten, ohne dass individuelle Konvertierungseinstellungen für Absätze, Tabellen, Bilder usw. festgelegt werden müssen.
Projektweite Konvertierungseinstellungen funktionieren am besten, wenn das gesamte Dokument entweder in FrameMaker oder in Word erstellt und mit RoboHelp veröffentlicht wird. In diesem Fall optimieren Sie einfach den Inhalt des Quelldokuments für die Veröffentlichung als Onlinehilfe und nehmen in RoboHelp nur geringfügige oder gar keine Änderungen am Inhalt mehr vor. In einer gemischten Authoringumgebung oder bei Inhalten aus verschiedenen Quellen ist der Arbeitsablauf komplizierter. Unterschiede in Bezug auf die folgenden Komponenten können die Komplexität erhöhen:
- FrameMaker-Vorlagen
- In RoboHelp können Sie eine Vorlage auswählen, die auf verknüpfte oder importierte FrameMaker-Dokumente angewendet wird. Die Vorlagen können sich je nach Dokumenttyp unterscheiden und verschiedene Absatz- und sonstige Formate enthalten.
- Muster für Themennamen
- Wenn Themennamen aus dem Absatztext abgeleitet werden, ergeben sich Komplikationen. Je nachdem, wie die Überschriften formuliert wurden, kann sich eine inkonsistente Benennung der RoboHelp-Themen ergeben. In FrameMaker-Dokumenten können Sie Themennamen anhand benutzerdefinierter Markierungen definieren. Dies ist in Word nicht möglich.
- Kontextsensitive Hilfemarkierungen
- Dank der Möglichkeit zur Definition kontextsensitiver Hilfemarkierungen in Quelldokumenten haben Sie die Erstellung der Onlinehilfe vollständig unter Kontrolle. Dadurch kann jedoch die Komplexität erheblich erhöht werden. Verschiedene Quelldokumenttypen verfügen in der Regel auch über verschiedene Markierungstypen, deren Syntax sich unterscheidet.
Tipps zur Erstellung kontextsensitiver HilfeBerücksichtigen Sie bei der Projektplanung die folgenden Hinweise:
- Arbeitsablauf festlegen
- Bei minimalen Änderungen an einem umfangreichen nativen RoboHelp-Projekt ist es sinnvoller, RoboHelp-Inhalte zu bearbeiten. Das Verknüpfen und Importieren externer Dokumente kann die Komplexität des Projekts erhöhen, besonders wenn Inhaltsverzeichnisse, Indizes, Glossare und kontextsensitive Hilfeeinstellungen in RoboHelp definiert wurden. Bei der Erstellung eines neuen Projekts oder wesentlichen Änderungen an einem vorhandenen Projekt sollten dagegen externe Dokumente verknüpft und importiert werden, um manuelle Änderungen in RoboHelp zu vermeiden.
- Festlegen der Quelldokumente
- Bevor Sie die Projekteinstellungen in RoboHelp definieren, legen Sie die Quelle für den Inhalt fest, den Sie im Projekt verwenden möchten. Wenn alle Quelldokumente ordnungsgemäß formatierte FrameMaker-Dokumente sind, verknüpfen Sie sie. Wenn Sie verschiedene Quelldokumenttypen verwenden, importieren Sie sie.
- Überlegungen zu Verknüpfungs- und Importoptionen
- Auch wenn Sie das Inhaltsverzeichnis, den Index und das Glossar von Quelldokumenten konvertieren können, wägen Sie Ihre Möglichkeiten sorgfältig ab. Importieren Sie das Inhaltsverzeichnis beispielsweise, wenn die Struktur des Inhaltsverzeichnisses in den Quelldokumenten erhalten bleiben soll. Wenn Sie FrameMaker- und Word-Dokumente aus verschiedenen Versionen importieren, sollten Sie ebenfalls Ihre Möglichkeiten genau überdenken, bevor Sie kontextsensitive Hilfemarkierungen oder Indexmarkierungen verwenden. Sie sind nur bei umfangreichen Änderungen vorteilhaft. Bei minimalen Aktualisierungen ist es oft weniger aufwendig, den Inhalt zu importieren und die Zuordnungs-IDs oder Indexeinträge in RoboHelp selbst hinzuzufügen.
Szenarien zur Erstellung eines Projekts
Quelldokumente
|
Methode
|
Verfügbare Optionen
|
|---|
Einzelnes unstrukturiertes oder strukturiertes FrameMaker-Buch
|
Verknüpfen eines FrameMaker-Buchs
|
Veröffentlichen der Inhalte in RoboHelp mit geringfügigen oder gar keinen inhaltlichen Änderungen Definieren von Seitenumbrüchen aufgrund von FrameMaker-Absatzformaten oder benutzerdefinierten Markierungen
Erstellen kontextsensitiver Hilfesysteme anhand benutzerdefinierter Markierungen in FrameMaker
Konvertieren von Inhaltsverzeichnis, Index und Glossar
|
Mehrere unstrukturierte oder strukturierte FrameMaker-Bücher
|
Verknüpfen von FrameMaker-Büchern
|
Veröffentlichen der Inhalte in RoboHelp mit geringfügigen oder gar keinen inhaltlichen Änderungen Definieren von Seitenumbrüchen aufgrund von FrameMaker-Absatzformaten oder benutzerdefinierten Markierungen
Erstellen kontextsensitiver Hilfesysteme anhand benutzerdefinierter Markierungen in FrameMaker
Konvertieren von Inhaltsverzeichnis, Index und Glossar
|
Ein oder mehrere FrameMaker-Bücher in älteren Versionen als FrameMaker 7
|
Importieren von FrameMaker-Büchern
|
Definieren von Seitenumbrüchen aufgrund von FrameMaker-Absatzformaten oder benutzerdefinierten Markierungen
Erstellen kontextsensitiver Hilfesysteme anhand benutzerdefinierter Markierungen in FrameMaker
Konvertieren von Inhaltsverzeichnis, Index und Glossar
|
Unabhängige FrameMaker-Dokumente
|
Importieren von FrameMaker-Dokumenten
|
Definieren von Seitenumbrüchen aufgrund von FrameMaker-Absatzformaten oder benutzerdefinierten Markierungen
Konvertieren von Inhaltsverzeichnis, Index und Glossar
|
Einzelnes Word-Dokument mit ordnungsgemäßem Inhaltsverzeichnis und Index
|
Verknüpfen eines Word-Dokuments
|
Definieren von Seitenumbrüchen anhand von Absatzformaten in Word
Definieren kontextsensitiver Hilfemarkierungen mit der Option für benutzerdefinierte Fußnoten in Word und Verwenden des Markierungstexts für die kontextsensitive Hilfe
Konvertieren von Inhaltsverzeichnis, Index und Glossar
Veröffentlichen der Inhalte in RoboHelp mit geringfügigen oder gar keinen inhaltlichen Änderungen
|
Mehrere Word-Dokumente
|
Importieren von Dokumenten
|
Definieren von Seitenumbrüchen anhand von Absatzformaten in Word
Definieren kontextsensitiver Hilfemarkierungen mit der Option für benutzerdefinierte Fußnoten in Word und Verwenden des Markierungstexts für die kontextsensitive Hilfe
|
Mischung aus FrameMaker-Büchern und Word-Dokumenten
|
Verknüpfen von FrameMaker- und Word-Dokumenten
|
|
Mischung aus unabhängigen FrameMaker- und Word-Dokumenten
|
Importieren von Dokumenten
|
|
Szenarien zur Aktualisierung von RoboHelp-Projekten
Quelldokumente
|
Methode
|
Verfügbare Optionen
|
|---|
Einzelnes unstrukturiertes oder strukturiertes FrameMaker-Buch
|
Verknüpfen eines FrameMaker-Buchs
|
Definieren von Seitenumbrüchen aufgrund von FrameMaker-Absatzformaten oder benutzerdefinierten Markierungen
Erstellen kontextsensitiver Hilfesysteme anhand benutzerdefinierter Markierungen in FrameMaker
|
Mehrere unstrukturierte oder strukturierte FrameMaker-Bücher
|
Verknüpfen von FrameMaker-Büchern
|
|
Mehrere FrameMaker-Bücher oder unabhängige FrameMaker-Dokumente
|
FrameMaker-Bücher und -Dokumente importieren
|
|
Einzelnes Word-Dokument mit ordnungsgemäßem Inhaltsverzeichnis und Index
|
Verknüpfen eines Word-Dokuments
|
|
Mehrere Word-Dokumente
|
Importieren von Dokumenten
|
|
Mischung aus unabhängigen FrameMaker- und Word-Dokumenten
|
Importieren von Dokumenten
|
|
|
|
|
