![]() |
|
|
Artikel
Service
|
Single-Source-Publishing gestern und heute
Wer technische Dokumentation erstellt, kämpft heute täglich damit, Information auf unterschiedlichen Medien bereitstellen zu müssen, und das bei gleichbleibend hoher Qualität, in kürzester Zeit und natürlich ohne zusätzliche Kosten.
Status quoUm verschiedene Medien zu bedienen, werden Texte gewöhnlich dupliziert und aus mehreren Textquellen mit Hilfe unterschiedlicher Tools mediengerecht aufbereitet. Das bedeutet nicht nur ständig zunehmende Datenmengen, die gespeichert und verarbeitet werden müssen, sondern auch schlechte Übersicht und hohen Verwaltungsaufwand. Noch dazu werden Informationen redundant gehalten, was die Datenpflege nicht gerade erleichtert. Die durch rasante Produktentwicklung vorgegebene Aktualisierungshäufigkeit erschwert das Ganze zusätzlich; da mehrere Quellen zu berücksichtigen sind, hinkt die Dokumentation der Produktentwicklung ständig hinterher. So kommt es, dass unterschiedlichste Versionen im Umlauf sind: so ist z. B. das Handbuch aktualisiert, die Online-Hilfe aber nicht. Und da fangen die Probleme erst richtig an. Wie und wo finde ich die handbuchseitig aktualisierten Textteile im Hilfe-Dokument? Wie gelingt es mir, im einen oder anderen Dokument nichts zu übersehen, nichts zu vergessen? An diesem Punkt entsteht der Wunsch, aus dem vorliegenden Handbuch möglichst per Mausklick eine Online-Hilfe zu erzeugen, ohne dass diese großartig nachformatiert werden muss. Es ist der Wunsch nach Single-Source-Publishing. Einseitige Behelfslösung: KonvertierenDer Markt hat längst reagiert. Es gibt verschiedene Tools, die Single-Source-Publishing propagieren, um die beschriebenen Probleme zu lösen. Also doch nur eine einzige Quelle, aus der alle Medienformate bedient werden können? Die Praxis zeigt erschreckende Resultate: Manche Tools gehen den Weg vom Print-Dokument zur Online-Hilfe, übersehen dabei jedoch die erheblichen strukturellen Unterschiede und Besonderheiten beider Varianten. Heraus kommt nichts anderes als das Handbuch in elektronischer Form. Die Vielfältigkeit im Informationszugriff, ein charakteristisches Merkmal echter Online-Hilfen, wird nur teilweise erreicht, die Kontextsensitivität erfährt Einschränkungen. All das, was die Online-Hilfe zum äußerst effizienten Informationsmedium macht, ist nur bedingt vorhanden. Fazit: Eine pdf-Datei hätte es auch getan. Andere Tools wiederum machen aus dem Online-Dokument eine Print-Version. Doch auch dieser Versuch scheitert letztlich an Strukturunterschieden, Datenmenge und Layout. Das größte Manko: Eine logische Abfolge von Informationseinheiten ist nicht ohne weiteres gegeben und keineswegs selbstverständlich. Um die im Handbuch erforderliche inhaltliche Linearität herzustellen, bedarf es aufwendiger händischer Vorarbeit oder Nachbearbeitung, die aus Zeit- und Kostengründen meist untragbar sind. Die Qual der Wahl: schlechtes Handbuch oder immenser Aufwand. Die meisten Tools sind primär für ein Medium konzipiert, das sie ohne jeden Zweifel perfekt bedienen. Mit nachträglichen, mühsamen Erweiterungen konnten sie sich zwar das Single-Source-Prädikat sichern, aber weder Add-ons noch eine Hand voll Makros ersetzen echten Cross-Media-Support. Wo liegt das Problem? Die meisten Tools versuchen, ein festgelegtes Dokumentenformat in ein völlig anderes zu konvertieren, also umzuwandeln. Aber solch wundersame Metamorphosen funktionieren nicht einmal im täglichen Leben. Aus einem Rührkuchen lässt sich kein Pfannkuchen machen, aus einem Pfannkuchen kein Rührkuchen, selbst wenn man über optische und geschmackliche Konsequenzen hinwegsieht. Mit Mehl, Eiern, Butter, Milch usw. ist jedoch beides problemlos möglich. Gleiches gilt auch für die Dokumentation. Die einzelnen Zutaten, also die Einzelinformationen sind zwar dieselben, müssen aber von Anfang an ergebnisorientiert zusammengestellt und verarbeitet werden, und zwar für jedes Medium anders. Vielseitige Alternative: GenerierenAuf der anderen Seite des Globus entschloss man sich, das problematische Konvertieren durch das weitaus effektivere Generieren zu ersetzen, und entwickelte in Neuseeland ein ausgeklügeltes, fortschrittliches Tool, das von vorneherein darauf ausgelegt ist, Online- und Print-Dokumente aus einer einzigen Datenquelle (Single-Source) zu erstellen, zu verwalten, zu publizieren:
Author-it (www.author-it.com, www.author-it.de). Es erzeugt Print-Dokumente, Windows Online-Hilfen, HTML-Hilfen sowie HTML-Seiten, ohne dass dabei die typischen Eigenschaften des einzelnen Mediums auf der Strecke bleiben, und vor allem ohne Tool-bedingte Qualitätseinbußen. Wo ist nun der Unterschied zu anderen Autorenwerkzeugen?Author-it ähnelt zunächst in vielen Punkten den heute üblichen Dokumentationsprogrammen, betont aber den Single-Source-Aspekt viel stärker, indem es Inhalt, Struktur und Layout voneinander trennt, wenngleich die Trennung nicht so streng ist wie bei SGML oder XML. Ziel ist es, die separat verwalteten EinzeIinformationen (Zutaten) flexibel und variabel kombinieren zu können, um aus demselben Daten-Pool diverse Zieldokumente mit unterschiedlichem Inhalt und für verschiedene Medien zu generieren. Aber der Single-Source-Gedanke geht noch weiter. Auch hinsichtlich Projektgruppenarbeit und Versionierung ist eine einzige Bearbeitungsquelle vorgesehen, d. h. mehrere Personen können parallel dieselbe Datenquelle bearbeiten, und basierend auf einer Datenquelle können unterschiedliche Versionen des gleichen Dokumentes erzeugt und verwaltet werden. Author-it unterstützt also Single-Source-Publishing in mehrfacher Hinsicht und realisiert die gesteckten Ziele mit Hilfe folgender Features:
Objektorientierung Bei der Software-Entwicklung wurde abgeschaut, was diese bereits seit vielen Jahren erfolgreich nutzt: Objektorientierung. Damit ist Author-it das erste Autorenwerkzeug, das zeitgemäß objektorientiert arbeitet. Wie das Bild zeigt, stehen 13 verschiedene Klassen von Objekten zur Verfügung:
Ein Author-it-Dokument setzt sich aus beliebigen Einzelobjekten zusammen, die unabhängig voneinander verwaltet und bearbeitet werden. Alle Objekte werden in einer zentralen Datenbank abgelegt und gespeichert. Schon bei der Erstellung können Sie festlegen, für welche Dokumente bzw. Medien ein Objekt gedacht ist. Aber auch nachträglich lassen sich Objekte über Drag and Drop problemlos einem weiteren Dokument zuordnen. Im Unterschied zu den bisher bekannten Verfahren bedeutet das: Nicht alle Objekte müssen zwangsläufig in jedem Dokument enthalten sein. So können Sie nicht nur einmal Vorhandenes ohne Duplizieren wieder verwenden, sondern auch Information bedarfsgerecht und selektiv nutzen. Eine konsistente Datenpflege ist dennoch gewährleistet. Wenn Sie ein Objekt aktualisieren, wird diese Änderung automatisch in allen betroffenen Dokumenten nachgezogen. Template-Unterstützung Templates (Formatvorlagen) werden ebenfalls als Objekte angelegt und bearbeitet. Dadurch können Sie für verschiedene Zielmedien auch unterschiedliche Formatierungs- und Layout-Vorgaben erstellen und die Gestaltung für jede Ausgabevariante passend machen. Alle Dokumenttypen können gleichermaßen berücksichtigt werden und das manuelle Nachformatieren von Print- oder Online-Dokument entfällt. Ob Sie das Aussehen Ihrer Dokumente von vorneherein festlegen oder nachträglich ändern, Sie erzielen in jedem Fall das gewünschte einheitliche Erscheinungsbild. Multiuser-Fähigkeit AuthorlT sieht vor, dass mehrere Benutzer(gruppen) im Netz parallel an einem Dokument arbeiten können, ohne sich gegenseitig in die Quere zu kommen. Dafür sorgen differenzierte Zugriffsrechte. Diese regeln nicht nur zulässige Bearbeitungsaktionen (das Erstellen, Ändern, lesen von Daten), sondern durch Öffnen oder Sperren einzelner Objektklassen, z. B. Templates, auch den inhaltlichen Zugang. Dadurch sind die Daten ohne Informationseinbuße bestmöglich geschützt. Denn auch wenn verschiedene Personen unabhängig voneinander Teilbereiche bearbeiten, kann das ganze Team jederzeit lesend auf einen vollständigen und aktuellen Datenbestand zugreifen. Um die Team-Arbeit zusätzlich zu erleichtern, werden alle Änderungen mit Uhrzeit und dem Benutzernamen protokolliert. So können Bearbeitungsstand eines Objektes sowie jeder einzelne Bearbeitungsschritt problemlos nachvollzogen werden; langes Suchen nach dem zuständigen Ansprechpartner erübrigt sich. Versionskontrolle
Dokumentation lebt. Und wenn es darum geht, unterschiedliche Dokumentationsstände zu verwalten, kommt auch mächtig viel Leben in die Technikredaktion. Nicht nur, dass ein und dasselbe Dokument in mehreren Versionen gespeichert und ausgeliefert werden muss, auch den Überblick zu behalten, ist nicht immer leicht. Deshalb bietet AuthorlT eine integrierte Versionskontrolle. Damit können Sie verschiedene Objekt-Versionen über Versionsnummern verwalten und müssen nicht mehr das gesamte Dokument duplizieren, um es dann an entsprechender Stelle zu ändern. Sie aktualisieren einfach die Objekte, die sich geändert haben. Beim Speichern vergibt das System automatisch die nächste fortlaufende Versionsnummer. Ältere Objekt-Versionen bleiben nach wie vor gespeichert und sind über die History View jederzeit abrufbar (siehe Bild), was auch den Versionsvergleich deutlich vereinfacht. Anhand der Versionsnummern können Sie problemlos und platzsparend verschiedene Dokumentversionen aus einer einzigen Quelle erzeugen. Und AuthorlT behält den Überblick.
Single-Source-Dokumentation in speAuthorlT macht uns Hoffnungen. Bleibt nur noch die Frage der Altlasten. Aber auch für Berge bestehender Dokumentation gibt es eine Lösung. Mit dem AuthorlT-Datenimport können Sie unterschiedlichste Dokumente (ob Texte oder Hilfen) einlesen und somit vorhandene Information weiterhin nutzen. So steht einem zukunftsorientierten Systemwechsel nichts mehr im Wege. AuthorlT jedenfalls ist mit seinem offenen Programmkonzept zukünftigen Anforderungen gewachsen, komme was wolle. Wenn auch Sie sich für die Zukunft rüsten wollen, sitzen Sie bei Comet Communication, dem Deutschlandpartner für AuthorlT, an der Quelle. 20.01.05 Christiane Schloßer - Technikredakteurin bei Comet Computer Weitere Artikel von Christiane Schloßer Mit dem Artikel verknüpfte Schlagwörter: |
|
|||
|
Startseite | Impressum | Kontakt Doku.Info ist ein Service von Comet Computer GmbH - Die Profis für Technische Dokumentation
|