Handbuch und Online-Hilfe: Single Source Publishing auf XML-Basis von bfj document services gmbh

Handbuch und Online-Hilfe: Single Source Publishing auf XML-Basis

Unser Leistungsangebot im Überblick:

Erstellung der DTD für Ihre Produktdokumentation.
Programmierung der XSL-Stylesheets zur Konvertierung in die Ausgabeformate PDF, RTF (Microsoft Word), Generic HTML, kompilierte HTML-Online-Hilfe (CHM) (weitere Formate nach Rücksprache).
Übernahme Ihrer bestehenden Dokumentation in die XML-Datenhaltung.

Warum Dokumentation mit XML?

XML (eXtensible Stylesheet Language) ist eine Metasprache zur Beschreibung von strukturierten Dokumenten und Daten, die sich im Laufe der letzten Jahre als Standard durchgesetzt hat.

Auch in der Technischen Dokumentation hat XML mittlerweile Bedeutung erlangt, bietet es doch folgende Vorteile:

Unabhängigkeit von Betriebssystemen und Tools
XML-Dateien liegen in einem Plattform unabhängigen Format vor, sind einfach editierbar (mit einem beliebigen ASCII-Editor oder mit speziell angepassten XML-WYSIWYG-Editoren) und können auch als Datenaustauschformat verwendet werden. Ihre Dokumentationsdaten sind somit unabhängig von Betriebssystemen und Werkzeugen. Spezifische Dokumentfunktionen, die von späteren Versionen oder Tools anderer Hersteller nicht (mehr) unterstützt werden, gehören der Vergangenheit an. Das bedeutet Zukunftssicherheit für Ihre Daten.

"Echtes" Single Source Publishing: Verschiedene Ausgabeformate
Aus einer XML-Datenquelle können mehrere Zielformate generiert werden, z.B. MS Word, PDF, Winhelp, HTML Help, etc. Die Generierung der Zielformate erfolgt mittels der Transformationssprache XSLT.

Versionen- und Variantensteuerung
Per "Knopfdruck" abrufbare Versionen und Varianten einer Dokumentation.
Über spezielle Tags und Attribute können den Inhalten Versions- und Variantenkennungen zugeordnet werden. Bei Bedarf kann somit aus dem "Datenpool" schnell und einfach die Dokumentation für eine bestimmte Variante oder Version erzeugt werden.

Modularisierung der Dokumentation
Inhalte müssen nur einmal erstellt und können dann zentral verwaltet, gepflegt und beliebig (wieder-) verwendet werden.

Einheitliches Dokumentationskonzept durch Strukturvorgabe
Erzeugung strukturierter Dokumente auf Basis einer speziell für Sie entwickelten bzw. auf Ihre Anforderungen angepassten DTD (Document Type Definition). Für Ihre Dokumentation bedeutet dies: Die in der DTD festgelegte Dokumentenstruktur gewährleistet konsistente und "uniforme" Dokumentationen.
Trennung von Inhalt und Darstellung
Der Autor muss sich nur um Inhalte kümmern, Formatierungs- und Strukturierungsaufgaben entfallen, was eine Zeit- und Kostenersparnis darstellt.

Optimale Anpassung an Ihre Anforderungen
XML ist beliebig erweiterbar und es bestehen keine Einschränkungen hinsichtlich der Syntax. Für die Dokumentation bedeutet dies, dass eine optimale Anpassung an Ihre Bedürfnisse möglich ist.

Einfache Übersetzung
XML-Dokumente können direkt mit Translation Memory-Systemen übersetzt werden.

Wie läuft ein "XML-Dokumentationsprojekt" mit bfj ab?

Phase 1 - Sichtung Ihrer Daten
Anhand der verfügbaren Daten und Ihrer spezifischen Anforderungen hinsichtlich Strukturierung und Ausgabeformate erarbeiten wir ein entsprechendes Konzept für das Single Source Publishing. Sollen Daten aus anderen Formaten nach XML konvertiert werden, müssen diese ebenfalls analysiert und deren Umsetzung projektiert werden.

Phase 2 - Entwicklung der DTD und XSL-Stylesheets
Angepasst an die Struktur Ihrer Daten entwickeln wir eine DTD als Basis für Ihre bestehenden und zukünftigen Dokumente. Für die Konvertierung der strukturierten Dokumente in die gewünschten Ausgabeformate erstellen wir die benötigten XSL-Stylesheets.

Phase 3 - Übernahme bestehender Daten in das XML-Format
Wir übernehmen Ihre bestehenden Daten in das XML-Format und entwickeln die entsprechende WYSIWYG-Umgebung zur Eingabe bzw. Bearbeitung der strukturierten Informationen.

Phase 4 - Dokumentationserstellung
Wir erstellen bzw. überarbeiten die Dokumentation auf Basis der entwickelten DTD und erzeugen die Zielformate via XSL-Konvertierung.

Phase 5 - Einrichten der XML-Dokumentationsumgebung in Ihrem Haus
Falls gewünscht, installieren wir die benötigte Umgebung zum weiteren Handling der Dokumentation und zur Erzeugung der Ausgabeformate in Ihrem Haus.

Weitere Informationen zum Thema "XML-basierte Dokumentation" erhalten Sie von Herrn Andreas Jäger.