Home Previous Zeitschrift 2001/12 Next Index
 
  Inhalt:
 
 
 
Produktionsprozesse technischer Dokumentation 
  
Technische Dokumentation und logische sowie visuelle Strukturen 
  
Werkzeuge für die Dokumentenproduktion – ein tabellarischer Vergleich 
  
DTP-/EP-Systeme für die Dokumentationserstellung, ein Überblick
  
Autor
  

 

Werkzeuge für die Produktion von technischer Dokumentation 

WinWord oder bloß nicht WinWord? 

Zumindest in der DACH-Region (DACH = Deutschland, Österreich, Schweiz)wird die Werkzeugauswahl und eine Bewertung gern auf die Frage reduziert: Was benötigen wir noch außer WinWord? Gleichzeitig begeht man damit gern den Fehler die Dokumentenproduktion auf den einmaligen Erstellungsprozeß zu beschränken. Bei tabellarischen funktionalen Vergleichen, die lediglich Funktionen ohne Praxistests gegenüberstellen, erreicht Word auch spielend den Spitzenplatz: „Word kann alles – und was es nicht kann, erreicht man mit der Makroprogrammierung“. 

Praxistests kommen jedoch zu anderen Urteilen, Beispiel c’t: „Sieht man von TeX ab(…) gibt es für aufwendige Bücher noch keine Alternative zu FrameMaker (…) Beim Buchsatz wäre Word 97 der einzige Konkurrent im Testfeld – würde es sich nicht durch Unzuverlässigkeit disqualifizieren.“ c’t, Heft 9 1997. 

Auch itl, das Institut für technische Literatur, unter anderem bekannt wegen eines der aufwendigsten Tests von Publishingsystemen, kommt zu einem ähnlichen Ergebnis: „WinWord ist eine geniale Katastrophe – genial in der Funktionenvielfalt, katastrophal in der Gesamtkonzeption unter der Anforderung ‘Erstellung und Pflege von größeren, strukturierten Dokumenten mit vielen Text-Bild-Kombinationen‘ “ (Dieter Gust, itl GmbH). Das Service Pack zu Word 2000 ändert übrigens an der Beurteilung nichts! Um eine zweckgerechte Liste und Bewertung der Werkzeuge zu erhalten muß man den gesamten Produktionsprozeß der technischen Dokumentation im Auge behalten. 

Grundregel 1: 

Den gesamten Produktionsprozeß der technischen Dokumentation im Auge behalten 

Produktionsprozesse technischer Dokumentation 

Produktionsprozesse technischer Dokumentation – Kern-Prozeß 
 

Prozeßschritte Werkzeugkategorie
Daten erzeugen Editor, Datenbank
Inhaltliche Strukturen und
Präsentationsstrukturen sowie Dateistrukturen
zuordnen
DTP-/EP-System: Templates, Dokumentvorlagen,
Explorer
Aus Daten Informationen erzeugen,Informationen aufbereiten/strukturieren DTP-/EP-System: Schnittstellen zuDatenbanken, Textbaustein-Funktionen oder –system Video-/Digital-Kamera Text-/Grafik-/Tabellen-Editor
Individuelle Verknüpfungen/Links erzeugen DTP-/ EP-System Querverweis-/ Index-/ Hyperlinkfunktionen
Abgeleitete Informationen und Linksgenerieren (Inhaltsverzeichnisse, Index) DTP-/EP-System: Buchfunktionen (automatische Kolumnentitel, Inhaltsverzeichnis-/ Index/ sonstige Listengenerierung)
Medienabhängiges Publishing: Papierproduktion gedrucktes Dokument 
HTML/WWW 
PDF/WWW oder CD-ROM
SGML/WWW oder CD-ROM
DTP-/EP-System HTML-Editor/ Site-Management-System
Spezielles Online-System, z.B. Adobe Acrobat: 
Viewing-Komponente, Interaktive Funktionen, Volltextindex

Ergänzender Prozeß: Übersetzung 
 

Prozeßschritte Werkzeugkategorie
Informationen exportieren nach Win-Word oder speziellem Editor eines Translation-Memory-Systems  Spezial-Konverter (Layout-Split) (klassische Filter, etwa RTF sind in der Regel untauglich)
Pre-Translation durch Translation- Memory-System oder Markieren neu zu übersetzender Teile  Translation-Memory-System oder DTP-/EP-System: Funktion „Änderungsbalken“ und „Dokumentvergleich"
Vervollständigen der Übersetzung  Word für Windows oder Editor eines Translation-Memory-Systems Ergänzend: Terminologie-Datenbank
Re-Layout des fertig übersetzten Dokuments: manuell oder durch Spezial- Konverter  Spezial-Konverter (Layout-join) oder manuell

Ergänzender Prozeß: Änderungen 
 

Prozeßschritte Werkzeugkategorie
Markieren der Änderungen  DTP/-EP-System Änderungsbalken
Erstellen der Änderungen und Re-Layout DTP-/EP-System oder neuer Report aus Datenbank
Re-Layout/Umbruch DTP-/EP-System

Ergänzender bzw. übergreifender Prozeß: Dokumentenmanagement 
 

Prozeßschritte Werkzeugkategorie
Konfigurationsmanagement: Verwalten der Dokumente über einzelne Bausteine/Module einfache Stufe: DTP-/EP-System:
Buchfunktionen, Referenzierungen 
umfassende Stufe: Datenbankanwendung
(DTP-System wird nur als
„Batchformatierer" verwendet)
Attributmanagement: Versionierung eines Dokuments und seiner Module,
Bearbeitungsstatus, Autor usw.
einfache Stufe: DTP-/EP-System: bestes Beispiel WinWord.
Umfassende Stufe: Dediziertes Dokumentenmanagement-
System. Verwaltung 
der Attribute über eine Datenbank
Management der Verfahrens/ QM- Dokumentation
nach DIN ISO 9000
einfache Stufe: Excel-Tabelle und Windows Explorer
umfassende Stufe: Konfiguration einer Datenbank bzw. eines Dokumentenmanagement-
Systems mit Auto-Generierung
ISO 9000 relevanter Dokumentation

Ergänzender bzw. übergreifender Prozeß: Archivierung 
 

Prozeßschritte Werkzeugkategorie
Datensicherung: täglich  einfache Stufe: WinZip, Windows Explorer, redundanter Sicherungsbereich
einer Festplatte
Sicherung von Projektdaten für
schnellen Zugriff: Zip-Drive, CD-RW, CD-R
Dediziertes Backup  Dediziertes Backup-System: DAT-Bänder, MO
Archivierung Dediziertes Archivierungssystem: Hierarchisch strukturierte Ablage der Daten, entsprechend der Nutzungsanforderung:
Schnellzugriff oder Langzeitarchivierung („dokumentenecht“)

Der Produktionsprozeß markiert nur die eine Seite der Medaille. Die zweite Seite der Medaille wird durch folgende Begriffe definiert: 

  • unstrukturierte Daten (Fließtext) – strukturierte Daten (Daten als Tabelle oder Baumstruktur abbildbar) 
  • unstrukturierte Dokumente (etwa Werbeflyer) – strukturierte Dokumente (Bedienungsanleitungen, Produktbeschreibungen, die über technische Daten hinausgehen) 
Technische Dokumentation und logische sowie visuelle Strukturen 

Um eine zweckgerechte Liste und Bewertung von Werkzeugen für die Dokumentationserstellung zu erhalten, muß man neben dem Produktionsprozeß auch die Daten- bzw. Informationsform unstrukturiert – strukturiert benennen können. 

Grundregel 2: 

Erkennen, welche Daten (unstrukturiert – strukturiert) und welche Informationsarten (unstrukturiert – strukturiert) überwiegen These: 

Außer bei Katalogen besteht technische Dokumentation mehrheitlich aus eher unstrukturierten Daten, die aber in strukturierter Information aufbereitet werden sollen; mit anderen Worten: Die Praxis der Dokumentationserstellung besteht überwiegend aus einer Kombination zweier Vorgehensweisen, die sich durchaus widersprechen können: 

  • seitenorientiertes eher unstrukturiertes Arbeiten 

  • dokumentorientiertes eher strukturiertes Arbeiten 
 
Beispiel für ein strukturiertes und kreatives Layout

These: Dort, wo eine „natürliche Modularisierung“ der technischen Dokumentation durch entsprechende Module der zu dokumentierenden Produkte nicht abgeleitet werden kann, ist eine automatisierte Dokumentenproduktion nicht erreichbar oder nicht sinnvoll! 

Es kann z. B. der Zwang entstehen, Dokumentmodule zu erfinden, die praktisch keinen Nutzen haben. Ein Beispiel bietet die Modularisierung von Softwaredokumentation auf Funktionen-Ebene: „Mit dem OK-Button bestätigen Sie den Befehl“. Diese Information ist sicher vielfach abrufbar, weil der OK-Button in einer Software sehr oft vorkommen kann. Welchen Nutzen aber besitzt diese Information für einen Anwender? 

Werkzeuge für die Dokumentenproduktion – ein tabellarischer Vergleich 

Die folgende tabellarische Übersicht stellt die bekanntesten Tools für den Bereich technische Dokumentation gegenüber: WinWord, Interleaf und FrameMaker. Das Nicht-Nennen anderer Tools ist durchaus als Botschaft zu sehen: So sind QuarkXPress und Page-Maker für größere, strukturierte Dokumente mit Autonumerierungen und Tabellensatz einfach nicht effizient einsetzbar, Punkt! Ausnahmesituationen sind durchaus denkbar, aber bestätigen die Regel! 

Dem Kenner muß eine Tabelle wie die folgende immer Bauchschmerzen bereiten: Zu jeder Bewertung müßte man seitenweise Bemerkungen definieren, die das jeweils lachende oder weinende Smiley und damit die pointierte Bewertung doch wieder völlig verwässern würden. Dennoch die Smileys und Bomben sind als grundsätzliche Botschaft zu sehen: 

Interleaf ist für strukturierte Dokumente das beste Tool, aber eben nur für solche! Und FrameMaker geht als strahlender Sieger mit weiten Abstand vor den anderen über die Ziellinie, wenn man die häufigste Anforderung der Praxis zum Maßstab macht: „Flexibilität bei der Kombination von strukturiertem und seitenorientiertem, kreativem Arbeiten.“ Relativ gesehen ist das Arbeiten mit FrameMaker und Interleaf sicher um Klassen effizienter als mit WinWord, wieder bestätigen Ausnahmen eher die Regel. Microsoft selbst sieht den Bereich technische Dokumentation überhaupt nicht als Zielgruppe an und bestätigt diese selbst immer wieder eindrucksvoll und vor allem wörtlich bestätigt wird. 

Alle Werkzeuge haben übrigens Bugs, die im Praxiseinsatz durchaus einen bemerkenswerten wirtschaftlichen Schaden anrichten können. Es wird Zeit, daß man diesen Schaden einmal versucht zu beziffern. 

Und wie geht’s weiter bei der Entwicklung der Tools? Wenn Microsoft bei Word die Zentraldokument-Konzeption und Dokumentvorlagen-Konzeption verändern würde und vor allem die Zielgruppe im Bereich „Technische Dokumentation“ endlich erkennen würde, könnte Word sich zu einer zunehmenden „Bedrohung“ für die beiden anderen Systeme entwickeln. Bei einzelnen Funktionen ist Word sogar vorbildlich und kann durchaus als Referenz dienen, siehe z. B. die Word 97-Funktion „Autoformen“, die leichte Konfigurierbarkeit von Symbolleisten und Menüs, oder eben die Makrosprache. Aber das Gesamtkonzept stimmt einfach nicht für den Bereich technische Dokumentation und daran ändert auch kein Service Pack etwas. 

Bei FrameMaker stimmt dagegen das Gesamtkonzept voll, allerdings benötigt FrameMaker bei Einzelfunktionen und deren Ergonomie dringend eine Auffrischungskur, etwa bei den Grafikfunktionen, der Rahmenfunktionalität oder bei der Ergonomie der Buchfunktionen. Interleaf ist in der Funktionalität für strukturierte Dokumente am weitesten ausgereift. Beim Thema Offenheit und Unterstützung von (Quasi)-Standards hat Interleaf jedoch einen dringenden Aufholbedarf: Der Interleaf-Desktop unter Windows 95/NT stört eher als das er nutzt, die mangelnde Unterstützung von Acrobat und Type 1 Schriften ist für viele Anwender ein gravierendes Problem. Überhaupt gliedert sich Interleaf unter Windows zumindest als Tool unter vielen anderen innerhalb einer Produktionsumgebung schwerer ein als die anderen Werkzeuge. 

Fazit: Im Gegensatz zu den Ergebnissen aus unsäglichen „Pseudotests“ ist die Wunschliste der Publishinganwender im Bereich Technische Dokumentation bei den Werkzeugen noch lange nicht umgesetzt. 

Noch deutlicher: der Bereich Technische Dokumentation benötigt weiterhin ausgereifte und stabillaufende Updates und Weiterentwicklungen der bekannten Publishing-Werkzeuge.   

DTP-/EP-Systeme für die Dokumentationserstellung, ein Überblick

   

Dieter Gust
Itl Institut für technische Literatur GmbH

 

Zum Seitenanfang
 


© ADOLPH Verlag GmbH - Letztes Update 03.05.2004