Sie sind hier: Startseite Transline tecNews Aller guten Dinge sind 3: XML-Editor, Funktionsdesign und Redaktionssystem - oder Informationslogistik mal ganz einfach! (Teil 2)
transline tecNews Veröffentlichung vom 14.10.2004
Artikelaktionen

Aller guten Dinge sind 3: XML-Editor, Funktionsdesign und Redaktionssystem - oder Informationslogistik mal ganz einfach! (Teil 2)

Informationslogistik, das ist mehr als das Hin- und Herschieben von Datensätzen. Damit die Effizienz der Technischen Dokumentation optimiert wird, müssen insbesondere Texte vorbereitet und mit Werkzeugen in ein System integriert, dort verwaltet und schließlich wieder in Zieldokumente exportiert werden. Ein Beispiel für ein produktives Teamwork von Komponenten ist das Funktionsdesign als Informationsstrukturierungsmethode, Microsoft Word als XML-Werkzeug und -Editor sowie SCHEMA ST4 als Redaktionssystem. Abschließend folgen ein Vergleich verschiedener Informationssysteme und ein kurzer Leitfaden zur Bewertung deren Anbieter. Das Ziel sämtlicher Anstrengungen ist: Kosten sparen bei gleichbleibender Qualität - wie, das verrät dieser Fachbeitrag.

Von Stefan Freisler

Inhalte

Egal was Sie machen, machen Sie es mit Methode!

Während es innerhalb anderer Ingenieurwissenschaften kaum denkbar wäre, nicht nach einer bestimmten Entwicklungs- bzw. Prozessmethodik zu arbeiten, befindet sich die professionelle Informationserstellung jedoch vielfach noch auf dem "Manufaktur-Niveau". Dabei gibt es längst verfügbare Alternativen, um die Schreib- und Strukturierungsarbeiten systematisch zu standardisieren. Nach dem Motto: Jede Frage sollte geklärt werden, aber bitte nur einmal und nicht jedes mal wieder neu, bietet sich gerade "Funktionsdesign" als Methode an.

Die Methode Funktionsdesign wurde von den Professoren Robert Schäflein-Armbruster und Jürgen Muthig (beide lehren heute Technische Kommunikation an den Fachhochschulen Furtwangen bzw. Karlsruhe) Anfang der 90er Jahre aus der Taufe gehoben und seither kontinuierlich in zahlreichen Industrieprojekten weiterentwickelt.

Durch die Methode Funktionsdesign werden komplexe Informationsprodukte, wie z.B. Betriebsanleitungen, Handbücher oder Montageanweisungen, weitgehend standardisiert. Sie nimmt Einfluss auf logische und didaktische Strukturen sowie Satzbau und Stil. Zusätzlich sind die Informationsprodukte in ihrer visuellen Gestaltung konsistent, weil eine durchgängige Nutzung von Design, Typografie, Layout und Grafik-Einsatz erreicht wird. Langatmige Textpassagen werden durch kurze, in ihrer Funktion eindeutige Sätze ersetzt. Der Anwender kann auf einen Blick erkennen, welche Funktion, z.B. Voraussetzung, Handlung, Resultat, eine Textpassage hat. Ein Unternehmen, das Funktionsdesign konsequent bei der Erstellung seiner Informationsprodukte einsetzt, kann durch die konsistente Terminologie anfallende Übersetzungskosten reduzieren. Beim Einsatz von Translation Memory Systemen wird damit die Anzahl der 100%-Matches drastisch erhöht. Auch der zeitliche Aufwand wird minimiert, denn bei der Erstellung können ganze Textpassagen mehrfach verwendet werden, weil diese jetzt standardisiert vorliegen! Hier leistet vor allem ein Redaktionssystem wertvolle Dienste, weil Texte nicht als ganze Dokumente, sondern als Textbausteine verwaltet werden.

Die vier Ebenen des Funktionsdesigns. Screenshot: Freisler.

Die vier Ebenen des Funktionsdesigns. Screenshot: Freisler.


Funktionsdesign in der praktischen Umsetzung mit SCHEMA ST4 und MS Word 2003

Analyse der Informationsprodukte und Einführung von Funktionsdesign

Um die Methode Funktionsdesign erfolgreich einzusetzen, werden zunächst die verschiedenen Informationsprodukte analysiert und definiert (z.B. Bedienhandbuch, Gebrauchsanleitung oder Wartungsanweisung). In einem zweiten Schritt werden für jedes Informationsprodukt sogenannte "funktionale Einheiten" identifiziert. Funktionale Einheiten sind Textteile, denen eine bestimmte Funktion zugeordnet werden kann, etwa eine Handlungsanweisung oder eine Warnung. Diese lassen sich zu sogenannten "Sequenzmustern" zusammenfassen. So wird eine lernlogische Abfolge von funktionalen Einheiten geschaffen, z.B. Handlungssequenzen oder Warnhinweise. Für einzelne Elemente innerhalb der Informationsprodukte, die besonders hervorgehoben werden sollen, werden dann noch sogenannte "Auszeichnungselemente" bestimmt.

Nach dieser Analysephase erfolgt die IT-gestützte Umsetzung des Funktionsdesigns. Dies kann durch ein auf XML (eXtensible Markup Language) gestütztes Redaktionssystem geschehen. Je nach Anforderung werden ein oder mehrere XML-Schemas erstellt, welche die zuvor identifizierten und definierten Strukturen erfassen. XML Schemas sind mit Schablonen oder Vorlagen zu vergleichen, in welchen Struktur und Art von XML-Daten festgelegt sind. XML ist eine reine Auszeichnungssprache, mit der Struktur und Inhalte der Daten getrennt von der Darstellung beschrieben werden. Mit Hilfe dieser XML-Schemas steuert das Redaktionssystem SCHEMA ST4 die Dokumentstrukturen. Dabei verwaltet SCHEMA ST4 Texte und Bilder in abgeschlossenen Bausteinen. Klickt der Anwender auf einen Baustein zur Bearbeitung, öffnet sich automatisch MS Microsoft Word mit den dazugehörigen Dokument- und Formatvorlagen sowie AutoTexten.

Microsoft Word 2003 mit SmartDoc-Funktion als XML-Editor. Screenshot: Freisler.

Microsoft Word 2003 mit SmartDoc-Funktion als XML-Editor. Screenshot: Freisler.


Dokumentation mit Microsoft Word als XML-Editor

Viele Unternehmen setzen bei der Auswahl des Editors auf Microsoft Word. Hierfür sprechen auch viele Gründe: Das System ist Marktführer und in den meisten Unternehmen bereits vorhanden, so dass kaum Kosten für die Anschaffung entstehen. Während sich auf technischer Ebene natürlich auch andere Editoren (z.B. Adobe FrameMaker) eigenen, spricht die Verbreitung doch sehr für MS Word.

Sehr viele Mitarbeiter beherrschen das System bereits, so dass nur geringe Aufwände für Schulungen anfallen. MS Word ist durchgehend unicodefähig und daher für mehrsprachige Unterlagen besonders geeignet. Und ab der Version 2003 ist MS Word nun auch ein vollwertiger XML-Editor mit umfangreichen neuen Funktionalitäten, die den Redaktionsalltag erleichtern.

Die Arbeitsweise mit MS Word und SCHEMA ST4 unterscheidet sich, je nachdem, ob Sie die XML-Funktionen nutzen oder nicht. Wenn Sie mit einer älteren Version als MS Word 2003 arbeiten, arbeiten Sie mit einer Dokumentvorlage. Diese ermöglicht es, dass Ihre Dokumente beim Speichern in der Datenbank das Redaktionssystem in valides XML umgewandelt werden, d. h. Struktur und Datentyp der Informationen sind gemäß des XML Schemas gehalten.

MS Word 2003 hingegen ist bei Anwendung im XML-Modus ein vollwertiger XML-Editor, so dass auf den bisher nötigen, zusätzlichen Konvertierungsschritt nach XML verzichtet werden kann. Darüber hinaus können Sie beim Arbeiten mit MS Word 2003 auf besondere Komfortfunktionen zurückgreifen, die das Schreiben sehr erleichtern. Neben einer Strukturführung, die für einen XML-Editor Standard ist, bietet MS Word 2003 die sogenannten "SmartDocuments" an.

Microsoft Word 2003 mit SmartDoc-Funktion als XML-Editor. Screenshot: Freisler.

Microsoft Word 2003 mit SmartDoc-Funktion als XML-Editor. Screenshot: Freisler.


Mit Hilfe von SmartDocuments, kann der Anwender die Texte nun auch einfacher erstellen: MS Word folgt automatisch der im XML Schema hinterlegten Struktur für die entsprechende funktionale Einheit oder das entsprechende Sequenzmuster. Die Formatierung hingegen geschieht im Hintergrund. Außerdem können SmartDocuments Inhalte eines Redaktionsleitfadens aufnehmen. Der Redakteur kann so auf weiterführende Informationen und Formulierungshilfen zu dem Textbaustein, den er gerade bearbeitet, zugreifen. Sämtliche Inhalte werden in XML gespeichert und somit medienneutral gehalten. Dadurch kann der Anwender die Dokumente in unterschiedliche Medien (Print, Internet, CD-ROM oder Online-Hilfe) gemäß dem Single-Source-Publishing-Prinzip publizieren. Mit SmartDocuments können weitreichende Hilfestellungen zum Einfügen von Elementen gegeben werden. SCHEMA ST4 verfügt auch über eine spezielle Erweiterung, mit der z.B. ein Redaktionsleitfaden im SmartDocument angezeigt werden kann.

Welches System soll es denn sein?

MS Word als Editor und Funktionsdesign als Methode können eine gute Grundlage für weitere Schritte bieten. Doch der Aufbau einer Keimzelle der Informationslogistik ohne Redaktionssystem ist schwer möglich, denn ein XML-Editor bietet (selbst zusammen mit der besten Methode) viele Funktionen nicht, die für funktionierende Informationslogistik unabdingbar sind. Zwar verbringt der Redakteur viel Zeit am Editor, die meisten elementaren Funktionalitäten zum Aufbau einer später unternehmensweit nutzbaren "Content-Plattform" sind jedoch in einer Systemumgebung angesiedelt.

Folgende Faktoren verdeutlichen dies:

  • Echtzeit Multi-User-Umgebung (Rollen, Rechte, Sperren)
  • Anspruchsvolle Suche (Attribute, Metadaten, Volltext)
  • Übersetzungsmanagement
  • Workflow-Unterstützung
  • Versionierung auf allen Ebenen (Bausteine und Strukturen)
  • Wiederverwendung auf Baustein- und Strukturebene

Folgende grundsätzlichen Systemtypen stehen - natürlich mit z.T. fließenden Grenzen - zur Auswahl:

  • Archivsysteme
  • Dokumenten Management Systeme
  • Content Management Systeme
  • Redaktionssysteme

Archivsysteme

Unter einem Archivsystem "im klassischen Sinne" verstehen wir ein System zum Einscannen großer Mengen zunächst in Papier vorliegender Informationen. Diese Dokumente werden über mehr oder weniger stark ausgeprägte Automatismen auf Massenspeicher zur späteren Suche gespeichert.

Archivsysteme sind häufig notwendiger Bestandteil der Unternehmensinfrastruktur, können aber in der Regel nicht als Ausgangsbasis für eine Keimzellen-Strategie im oben genannten Sinne genutzt werden. Allein das Stichwort "Medienneutralität der Datenhaltung" macht klar, warum das so ist.

Dokumenten Management Systeme

Unter einem Dokumenten Management System (DMS) "im klassischen Sinne" verstehen wir ein System, über das der Anwender in der Lage ist, beliebige binäre Dateien zu verwalten und zu archivieren. Ein DMS ist dort sinnvoll, wo unternehmensweit große Mengen heterogener binärer Daten anfallen, die nicht mehr einfach im Dateisystem des jeweiligen Betriebssystems bzw. der Serverumgebung verwaltet werden können. Den Mehrwert, den ein DMS gegenüber dem Dateisystem entfaltet, besteht dann z.B. in einer Versionierung der jeweiligen Dateien.

Obwohl viele DMS-Hersteller ihre Systeme mit XML-Unterstützung anbieten, ist hier die Nutzung dieser Technologie oft nur rudimentär. Und in Bezug auf die Granularität, d.h. die Größe der vom System beherrschbaren Informationsbausteine, handelt es sich meist immer noch um ganze, in sich geschlossene Dokumente und nicht um Textbausteine.

Während ein Redaktionssystem (und z.T. auch ein Content Management System) meist fast alle Funktionen eines DMS umfassen muss, ist dies umgekehrt nicht der Fall.

Content Management Systeme

Unter einem Content Management System (CMS), wird im allgemeinen ein System verstanden, dass es dem Anwender ermöglicht, Dokumente zu erstellen und zu verwalten, die mit einer Auszeichnungs-Sprache wie z.B. HTML (Hyper Text Markup Language) ausgezeichnet wurden. Der Hauptunterschied zu einem klassischen DMS besteht zunächst darin, dass unter einem Dokument nun nicht mehr ein beliebiges binäres Dokument verstanden wird, sondern ein Dokument, dessen interne Struktur dem System mehr oder weniger bekannt ist. Die meisten CMS sind HTML-orientiert, d.h. dienen dazu, Intranets oder Internet-Auftritte zu erstellen. Viele CMS enthalten zusätzlich eine Server-Komponente, wobei z. B. Suchfunktionen integriert werden können. Natürlich gibt es zunehmend auch Überlappungsbereiche zwischen Funktionalitäten von klassischen DMS und CMS der neueren Generation, aber der Hauptunterschied ist, dass ein CMS immer eine Generator- und Serverkomponente enthalten muss, mit der Dokumente erzeugt und dem Leser präsentiert werden.

Redaktionssysteme

Während ein klassisches DMS keine Aussage über das Medium der gespeicherten Daten macht (es geht ja gerade um das Verwalten von heterogenen Datenformaten) ist ein CMS häufig noch eingeschränkt auf die Produktion von statischen oder dynamischen HTML-Webseiten (es ging ja in der Vergangenheit dieser Systeme häufig um die Erstellung von Web-Auftritten). Sobald also eine Reihe von Faktoren bzw. Anforderungen zusammenkommen, steigt die Wahrscheinlichkeit, dass ein Redaktionssystem mit bestimmten DMS- und CMS-Funktionen erforderlich ist, welches sich bei einem Ausbau in Richtung unternehmensweite Informationslogistik nahtlos in die Unternehmenslandschaft integrieren lässt. Hierbei ist wichtig, auf offene Systemarchitektur zu achten: Schnittstellen bzw. APIs (Application Programming Interface) sollten offengelegt und sauber dokumentiert sein.

Aspekte zur Bewertung und Auswahl eines Systemanbieters

Es existieren verschiedene Anbieter am Markt, die den Anspruch erheben, die genannten Anforderungen erfüllen zu können. Einige Aspekte sind bei der Bewertung und Auswahl eines Systemanbieters von besonderem Nutzen:

Positionierung

Als erste und wichtigste Frage sollten Sie klären, ob der Anbieter Ihre Anforderungen überhaupt als seine Kernaufgabe sieht und sich deshalb voll und ganz darauf konzentriert. Beispielsweise ist zweifelhaft, ob ein Anbieter etwa gleichzeitig "Dienstleister für technische Dokumentation" und Hersteller eines hochkomplexen Redaktionssystems sein kann.

Trotz der technologischen Kompetenz, welche durch eine Konzentration auf Kernkompetenz in der Regel entstehen sollte, sind "Software und Technologie" nur die halbe Miete. Die andere Hälfte sind Branchenkenntnis und Prozess-Know-how. Deshalb ist es empfehlenswert, dass der Systemhersteller ein Softwarehaus mit einem Standardprodukt und ausgeprägter Beratungkompetenz ist.

Art und Alter der Technologie

Von entscheidender Bedeutung ist natürlich die Art der Software: Stimmt die Qualität? Stimmt der Funktionsumfang? Ist alles dokumentiert und möglichst fehlerfrei etc.

Neben diesen im Detail zu überprüfenden Fakten sollte in Betracht gezogen werden, dass auch ein Softwareprodukt einem Lebenszyklus unterliegt: Nach 10 Jahren ist eine Software mit Sicherheit "am Ende", wenn man nicht von großen "Rundumrenovierungen" Kenntnis hat.

Wird auf die Frage nach dem "Alter der Software" mit "Mehr als 5-7 Jahre" geantwortet, dann ist dies als sehr problematisch in bezug auf die aktuellen Standards und Programme zu werten. Wird geantwortet "Gerade in der Fertigstellung" oder "brandneu" ist dies als problematisch in bezug auf Verfügbarkeit, Fehleranzahl und Risiko zu werten.

Standard-Software

Häufig wird argumentiert, dass die genannten Anforderungsfelder durch gängige Standards abgedeckt sind und eine  Standardsoftware nicht nötig ist. Unabhängig von der Tatsache, dass es dann eigentlich gar keine Anbieter von Standardsoftware auf diesem Gebiet geben dürfte, sollen im Folgenden wichtige Argumente für die Nutzung von Standardsoftware angeführt werden.

  • Anstehende Aufgaben können schnell realisiert werden: Die Software ist ja bereits existent. Individualsoftware muss erst noch mit einem nicht zu unterschätzenden Risiko entwickelt werden. Die benötigte Zeit für die Anpassung eines Standardproduktes meist wesentlich geringer als diejenige für eine individuelle Neuentwicklung. Entwicklungskosten sind auf viele Anwender verteilt. Dadurch entsteht mittelfristig ein Kostenvorteil, obwohl die Standardsoftware anfangs als größerer Kostenblock erscheint. Schließlich wurde die Arbeit ja schon geleistet und wird auch in Zukunft in Form von Updates geleistet. Leider haben sich Erfahrungen mit der sogenannten "Salami-Taktik" gehäuft, d. h. eine Lösung wird als wesentlich günstiger angepriesen, als diese nachher tatsächlich realisiert werden kann.
  • Das fachliche Know-how für eine Anwendung wird im Software-Produkt mitgekauft. Wer Standardsoftware kauft, kauft über Jahre hinweg "kondensiertes Fach-Know-how". Das Produkt würde nicht existieren, wenn es sich nicht in einer Vielzahl von Anwendungsfällen bereits bewiesen hätte.
  • Bei einem Produkt aus einem guten Softwarehaus kann man eine ausgereifte technische Lösung erwarten. Eine Software, die seit längerem bei einer Vielzahl von Anwendern eingesetzt ist, dürfte stabil und ausgetestet sein.

Zukunftssicherheit

Anbieter entwickeln ihre Produkte ständig weiter. Wer Zukunftssicherheit für Individualentwicklung haben will, muss den Quellcode des Systems im eigenen Haus pflegen, d.h. die Entwicklung mit allen Kosten und Risiken selbst betreiben. Zweifellos entstehen für Wartungsverträge für die Weiterentwicklung und den Support von Standardsoftware auch Kosten. Die Kosten sind gemessen am Nutzen aber meist vertretbar und es gibt hierfür marktübliche Standards. Beispiel: Eine Individualentwicklung kann bei einem Betriebssystem-Update deutlich höhere Kosten verursachen. Bei Standardsoftware verteilen sich solche Aufwände auf viele Kunden.

Kultur

Bei der Wahl eines Redaktions- bzw. Informationslogistiksystems entstehen langfristige Geschäftsbeziehungen zwischen den Firmen. Es handelt sich um eine Bindung auf unbestimmte Zeit. Aufgrund der Komplexität der Anforderungen und des Projektes ist es unumgänglich, dass die Kultur des Systemanbieters zu Ihnen passt! Was anderenfalls zu unproduktiven Diskussionen führt, ist schnell beseitigt, wenn die Chemie stimmt und man sich gut versteht.