Home Leistungen Über uns ImpressumKontakt

Sitemap


Informationsmanagement
und Technische Dokumentation
im Systemhaus HUHN dialog

I

Technische Dokumentationen müssen eine ganze Menge Anforderungen erfüllen. Bei variantenreichen Baureihen sollen sie möglichst präzise für jedes Gerät und doch schnell zu produzieren sein. Sie sollen industriellen Kennzeichnungsnormen und einem hohen Standard an Eindeutigkeit genügen, um Fehlbedienungen oder gar Unfälle zu vermeiden. Zudem sollten sie in verschiedenen Sprachen und für verschiedene Medien vorliegen.
Um diese Ziele möglichst effizient und damit kostensparend zu erreichen, muss man im Informationsmanagement den Weg der so genannten Modularisierung gehen. Ein Beispiel: Eine Betriebsanleitung soll für drei Varianten einer Maschine produziert werden. Anstatt nun drei verschiedene Anleitungen separat zu entwickeln, versucht man das Gerüst eines Dokuments zu entwerfen, das allen Baureihen genügen kann. Anschließend zerlegt man dieses Grundgerüst in Module, so dass man gleichbleibende Teile von variantenabhängigen Teilen trennen kann. Man zerlegt das Dokument damit in so genannte "Informationseinheiten". Diese Bausteine können einzelne Absätze, ganze Kapitel oder Abbildungen sein. Eine solche Analyse eines Dokuments erfordert viel Planung und Weitsicht. Sie wird von speziell dafür ausgebildeten Technischen Redakteuren vorgenommen.
Wenn ein Dokument komplett modularisiert vorliegt, kann man die einzelnen Informationseinheiten katalogisieren und zu jeder Informationseinheit die Information speichern, in welchen Varianten welcher Maschinen es an welcher Stelle platziert werden kann. Wenn die so entstehende Datenbasis umfangreich genug und gut strukturiert ist, kann man sich die Betriebsanleitung für eine bestimmtes Modell einer Baureihe mit der Maus "zusammenklicken". Das Prinzip ist ähnlich wie das bei Normteilen im Maschinenbau: Man wählt die speziellen Eigenschaften eines Modells (bei Autos wären das die Farbe, die Anzahl der Türen, die Art des Motors usw...) und das Dokument wird auf Basis der vorgegebenen Grundstruktur automatisch zusammengesetzt.
Durch diese Art des Informationsmanagements wird sichergestellt, dass alle Versionen einer Technischen Dokumentation strukturgleich und - wenn es in die Dokumentstruktur eingearbeitet ist - normengerecht sind. Neue Dokumente sind sehr schnell herzustellen, weil sie immer nur Abwandlungen schon existierender Dokumente sind. Die Übersetzungskosten sind minimal, weil die Informationseinheiten nur einmal übersetzt werden müssen.

II

So weit die Theorie. Wie realisiert man nun dieses Modulmanagement in einer Softwarelösung? Welche Werkzeuge stehen auf dem Rechner für diese Aufgaben zur Verfügung? Bevor man sich für eine Lösung entscheidet, muss man folgende Fragen klären:

(1) Wie sollen die Struktur eines Dokuments und die Strukturinformation der Module gespeichert werden?
(2) Wie sollen die Module verwaltet werden?
(3) Auf welche Weise soll das Dokument ein Layout bekommen und schließlich publiziert werden?

Als eine gute Lösung für den ersten Punkt haben sich die modernen Markup-Sprachen herausgestellt. "Urmutter" all dieser Sprachen ist SGML (Standard Generalized Markup Language). Diese Sprache und das neu für das Internet entwickelte XML (Extended Markup Language) lösen zwei Probleme auf einmal:
Sie erlauben erstens, die Struktur eines Dokuments festzulegen. Das geschieht durch die Definition eines speziellen Dokumenttyps (DTD, Document Type Definition). Man kann in einer solchen Definition festlegen, dass die Kapitel eines Dokuments immer in einer bestimmten Reihenfolge auftreten müssen, beispielweise:

1. Sicherheitshinweise
2. Bedienung
3. Wartung
4. Entsorgung
5. Technische Daten

Ein Programm, das diese Information berücksichtigt, würde zu einem späteren Zeitpunkt der Erstellung eines Dokuments nicht mehr zulassen, dass ein Technischer Redakteur einen Hinweis zur Wartung in das erste Kapitel setzt. Die Struktur des Dokuments ist festgeschrieben. Woher weiß aber ein Programm, dass es sich bei einem Stück Text um einen Wartungshinweis handelt?
Das führt auf den zweiten Vorteil von SGML und XML, der diese Sprachen zugleich am deutlichsten von HTML (Hypertext Markup Language) unterscheidet. Sie erlauben die Verwendung von so genannten "semantischen Tags", d. h. von (später unsichtbaren) Markierungen im Text, die Informationen über die Funktion eines Informationsbausteins enthalten. Diese Markierungen werden immer in Spitzklammern gesetzt. Ein Ausschnitt aus einem Dokument, das SGML/XML verwendet, könnte so aussehen:

<Wartung>
<Titel>Ölwechsel</Titel>
<Text>Am Fahrzeug muss alle zwei Jahre ein Ölwechsel vorgenommen werden.</Text>
</Wartung>

Textpassagen werde auf diese Weise "eingekapselt" in Informationen zu ihrer Funktion oder Zugehörigkeit (<...> eröffnet einen bestimmten Bereich, </...> schließt ihn wieder). Ein damit arbeitendes Programm "weiß" somit, wo eine Textpassage ihren Platz hat. Es kann daher feststellen, ob ein Dokument die Struktureigenschaften eines bestimmten Dokumenttyps erfüllt.
Die obige Passage ist ein Beispiel für eine Informationseinheit, in diesem Fall ist es ein Textbaustein. Nun kommt die Frage nach der Art der Speicherung und Katalogisierung dieser Informationseinheiten in den Blick. Sie ist am leichtesten zu beantworten.
Für die Informationseinheiten muss eine intelligente Verwaltung möglich sein. Außerdem müssen zusammen mit der Informationseinheit noch zusätzliche Angaben neben den reinen Strukturinformationen in den SGML/XML-Markierungen gespeichert werden, unter anderem die zentrale Information, in der Betriebsanleitung welches Modells dieser spezielle Baustein seine Verwendung findet. Diese Anforderungen sind von Textdokumenten allein nicht mehr zu leisten. Daher greift man für diese Aufgabe auf Datenbanklösungen zurück.
Die dritte und letzte Aufgabe, die eine Software erfüllen muss, ist die konkrete Umsetzung in ein gedrucktes bzw. im Internet oder auf CD-Rom verfügbares Dokument. Bisher enthalten die Dokumente nur Informationen darüber, welche Struktur als korrekt festgelegt ist, also welche Module wo ihren Platz haben. Es ist noch nichts über die Typographie und das Layout gesagt. Dafür benötigt man Programme aus dem Bereich Satz und Layout, die in der Lage sind, mit strukturierten Daten wie SGML-Dokumenten umzugehen. Durch die Auszeichnung des Textes mit Markierungen ist es möglich, einer bestimmten Textpassage (z. B. dem Wartungshinweis oben) eine bestimmte Formatvorlage oder Layoutschablone zuzuweisen. Auf diese Weise ist garantiert, dass Wartungshinweise immer gleich aussehen. Das hat mehrere Vorteile: Das Dokument wird nicht nur inhaltlich, sondern auch gestalterisch durchgehend konsistent. Der Technische Redakteur kann sich nach der Ausarbeitung der Formatvorlagen (die auch ein Grafiker oder Typograph vornehmen kann) voll auf die Formulierung des Inhalts konzentrieren.

III

Für die Aufgaben des Informationsmanagements gibt es Komplettlösungen zu kaufen. Das Problem bei diesen Produkten ist der Preis, der sich oft im fünfstelligen Bereich bewegt (und dabei ist der Preis für ein gutes Layout-Programm noch nicht mitgerechnet).
Das Systemhaus HUHN dialog hat Wege gefunden, intelligentes Informationsmanagement auch mit preisgünstigeren Lösungen zu verwirklichen. Viele Anbieter im Maschinenbau möchten die Vorteile strukturierter Dokumente zu Verfügung haben, stellen aber nur eine kleine Stückzahl einer Baureihe her, so dass sich die Ausgaben für ein komplettes SGML-System nicht lohnen.
HUHN dialog verwendet für diese Kunden die Software FrameMaker von Adobe in der Version 5.5.6. Diese Software ist in der Lage, alle drei erwähnten Aufgabengebiete in einem Programm zusammenzufassen.
Framemaker bietet die Möglichkeit, Textbausteine und Grafiken per Referenz in ein Dokument einzufügen. Das heißt: In einer Datei steht nicht mehr der Text selbst, sondern ein Verweis zu einer Datei, die die Textpassage enthält. Wenn sich der Text in dieser referenzierten Datei ändert (etwa durch eine Fehlerkorrektur), ist der Fehler automatisch in allen Dokumenten korrigiert, die diesen Textbaustein verwenden. So bekommt man mit einer Menge von Textbausteinen in Einzeldateien eine ähnliche zentrale Datenbasis wie in einem Datenbanksystem.
Die Verwaltung dieser Textbausteine erfolgt über eine Skriptsprache. Mit Hilfe von definierten Dokumentschablonen (ähnlich den DTDs) kann man Programme schreiben, die Dokumente in einer ähnlichen Weise "vorkonstruieren" wie in einem SGML-System. Mit einzelnen Plug-Ins lassen sich diese Funktionen noch weiter ausbauen. Durch die Modularisierung sind die Dokumente aber auch so gut strukturiert, dass ein späterer Umstieg auf eine volle SGML-Lösung möglich ist.
Zusätzlich zur Referenzierung kann FrameMaker mehrere Versionen eines Dokuments auch in einer Datei verwalten. Textteile können mit s ogenannten "Bedingungen" formatiert werden, die dafür sorgen, dass diese Teile ein- und ausgeblendet werden können. Das ist praktisch, wenn beispielsweise mehrere Sprachversionen eines Dokuments in einer Datei vorliegen. Blendet man alle außer den mit der "Italienisch"-Bedingung formatierten Teile aus, hat man eine fertige italienische Version des Dokuments. Bedingungen können natürlich auch für kleinere Unterschiede in Baureihen oder ähnliches verwendet werden.
Neben diesen ausgereiften Möglichkeiten des Informationsmanagements stellt FrameMaker ein vollwertiges Satz- und Layout-Programm dar. FrameMaker unterstützt Formatvorlagen für Texte und Absätze. So können alle Dokumente einheitlich und damit klar und übersichtlich gestaltet werden. Neben professionellen Optionen für die Druckvorstufe bietet FrameMaker Exportmöglichkeiten in das PDF-Format (für die Publikation auf CD-ROM) oder in HTML und XML (für das World Wide Web).

IV

Professionelles Informationsmanagement muss nicht teuer sein. HUHN dialog zeigt, wie man mit preisgünstiger Standardsoftware qualitativ hochwertige Lösungen erzielen kann.
Natürlich ist Informationsmanagement nicht alles, was für eine Dokumentation auf hohem Niveau nötig ist. Genauso wichtig ist eine eindeutige Verwendung von Begriffen in den Texten selbst. Dazu folgt HUHN dialog dem Prinzip der Kontrollierten Sprache, die feste Regeln für Wortwahl und Satzbau vorsieht.
Auch die Fachübersetzung muss das modulare Konzept der Dokumente und die Konsistenz der Sprache nutzen können. Deshalb arbeitet HUHN dialog mit einer maschinellen Vorübersetzung. Je mehr Arbeit durch ein Programm übernommen werden kann, desto mehr Zeit bleibt für redaktionelle Feinarbeit.
Dass sich im Team von HUHN dialog neben Redakteuren und Fachübersetzern auch Linguisten und Informatiker finden, ist also kein Zufall. Nur durch eine enge Zusammenarbeit von Spezialisten kann das entstehen, was ein Einzelner nicht mehr und eine Software allein (noch) nicht kann - klare und verständliche Technische Dokumentation.

Kontakt


Der Firmengründer