| Aktuelle Artikel und Nachrichten rund um die technische Dokumentation finden Sie im Nachfolgemagazin der doculine news, den transline tecNews
Strukturiertes Erstellen von technischer Dokumentation
auf Basis von Microsoft Word
Artikel erschienen in
Ausgabe September 2002
Von Ulrich
Pelster
Inhaltsübersicht:
Die Office-Welt von Microsoft hat
sich zum weltweiten Standard entwickelt und ist aus den Büros
von heute nicht mehr wegzudenken. Wie aber sieht es im Bereich
der technischen Dokumentation aus? Kann man auf Basis von Microsoft
Word professionelle Dokumentationen erstellen und gleichzeitig
effizient arbeiten?
Die Vorteile nutzen, die Probleme umgehen
Vielerorts kursiert die Überzeugung, dass eine professionelle
Erstellung von technischer Dokumentation nur mit speziell für
diese Anforderungen entwickelter Software zu bewerkstelligen ist.
Anwender von Tools wie z.B. Framemaker oder Interleaf werden jede
Behauptung, es ginge auch anders, zurückweisen.
In der Realität zeigt sich aber, dass immer mehr Unternehmen
auch ihre technische Dokumentation mit Microsoft Word erstellen.
Die direkten Vorteile liegen auf der Hand:
- keine hohen Lizenzkosten für Spezialistensoftware, da
die Office-Lizenzen in der Regel vorliegen
- geringerer Schulungsaufwand
- einfacher Austausch von Daten mit z.B. anderen Unternehmensbereichen
oder Übersetzungsdienstleistern
Andererseits stellt Microsoft Word den technischen Redakteur
allerdings auch vor einige Probleme – speziell, wenn es um
die Verwaltung von Inhalten umfangreicher Dokumente geht. Somit
stellt sich die Frage, wie sich die Vorteile optimal nutzen, aber
gleichzeitig die Probleme umgehen lassen.
Vor dieser Frage stand auch der Geschäftsbereich docuglobe
der technotrans AG. Als Dienstleister für technische Dokumentation
entwickelte docuglobe das Redaktionssystem doculab, welches weitgehende
Leistungsanforderungen des technischen Redakteurs abdeckt und
als Bearbeitungssoftware Microsoft Word unterstützt.
So arbeitet das Redaktionssystem doculab
Das Redaktionssystem doculab zerlegt Dokumentationen prinzipiell
in kleine Informationsmodule, die mit der visuellen Darstellung
einer Baumstruktur verwaltet werden. Wie in einem Stücklistensystem
werden auch die Dokumente, bestehend aus den einzelnen Informationsmodulen,
in Form einer Stückliste erstellt. Hierbei ist ebenfalls,
wie in den mechanischen Stücklisten, das Bilden von Baugruppen
(Modulgruppen) möglich.
Aus der Dokumentations-Stückliste generiert doculab schließlich
das Gesamt-Dokument. Dabei werden die im System verwalteten Eigenschaften
zur automatischen Erstellung des Deckblattes herangezogen. Inhaltsverzeichnis,
Index, Kopf- und Fußzeilen werden ebenfalls automatisch
erzeugt.
Die Verwaltung von Modulen und Dokumentationen stellt ein offenes
System dar. Das bedeutet, Ablagestrukturen, Eigenschaftenfelder,
Benutzerverwaltung usw. können den unternehmensspezifischen
Gegebenheiten entsprechend aufgebaut werden.
Dabei vermeidet doculab das Entstehen redundanter Daten: Jedes
Informationsmodul ist nach dem Single-Source-Prinzip einmalig
angelegt, kann aber in einer Vielzahl von Dokumentationen oder
auch in verschiedensten Dokumentationstypen (Handbuch, Datenblatt,
Servicehinweis usw.) vorkommen.
Die in der Vorlagenverwaltung erstellten Stylesheets ermöglichen
es, gleiche Inhalte in verschiedenen Dokumenten unterschiedlich
darzustellen. Die Vorlagen erlauben zudem ein einheitliches Erscheinungsbild
– egal, wie viele verschiedene Redakteure an einer Dokumentation
gearbeitet haben.
Mit Hilfe der Benutzerverwaltung lassen sich verschiedenen Personen
unterschiedliche Rechte und Rollen zugweisen, ob Administrator,
Redakteur, Sachbearbeiter oder Leseberechtigter. Für jeden
Benutzer kann der Zugriff entsprechend verwaltet werden.
Eine integrierte Sprachenverwaltung vermeidet zudem Mehrfachübersetzungen.
Dies erhöht die Qualität der Übersetzungen und
senkt die Übersetzungskosten.
 |
| Strukturiertes Verwalten von
Informationsmodulen und Dokumentationen |
Informationsmodule erstellen
Um ein Informationsmodul anzulegen, startet man aus der hierarchischen
Baumdarstellung heraus die Funktion "Neues Modul erstellen".
Diese Funktion übergibt den Anwender automatisch an Microsoft
Word und öffnet die entsprechende Modulvorlage. Ist das Modul
fertig, wird es automatisch an doculab zurückgegeben. Nun
können die entsprechenden Moduleigenschaften vergeben werden.
Nach dem gleichen Prinzip kann man aus bereits existierenden Informationsmodulen
neue Module erstellen oder bestehende Module ändern.
Komplexe Dokumentationen verwalten
Umfangreiche Dokumentationen verwaltet doculab wie Module in
einer hierarchischen Baumdarstellung. Beim Erstellen einer neuen
Dokumentation vergibt man zunächst die Dokumenteneigenschaften.
Die Gesamt-Dokumentation wird in Form einer Stückliste, bestehend
aus verschiedenen Einzelmodulen oder vorgefertigten Modulgruppen,
zusammengestellt. Dabei kann man auch eine bereits bestehende
Stückliste heranziehen und durch Austauschen bestimmter Module
oder Modulgruppen zu einer neuen Dokumentation zusammenstellen.
Beim Öffnen der Dokumentation übergibt die Stückliste
alle Module nach Microsoft Word. Deckblatt, Inhaltsverzeichnis,
Index, Layout usw. werden automatisch generiert. Das Öffnen
der Dokumentation in Microsoft Word ist in der Regel jedoch nicht
notwendig, da direkt aus dem System heraus die Dokumentation gedruckt
oder auch beispielsweise als PDF ausgeben werden kann.
Mit Hilfe von Verwendungsnachweisen kann man feststellen, in
welchen Dokumentationen oder Modulgruppen ein bestimmtes Modul
vorkommt. So lassen sich Auswirkungen bei einer Änderung
bzw. beim Löschen von Modulen beurteilen. Weiterhin besteht
die Möglichkeit, neben der Suche im Verzeichnisbaum über
eine klassische Eigenschaftensuche Module oder Dokumentationen
zu selektieren.
 |
| Dokumentationen werden in Form
einer Stückliste zusammengestellt. |
Sprachverwaltung
Mit doculab können beliebig viele Sprachen verwaltet werden.
Jedes erstellte Modul ist automatisch in allen Sprachen angelegt.
Solange ein Modul den Status "nicht übersetzt"
hat, wird es im System rot dargestellt. Fertige, übersetzte
Module werden grün dargestellt. Beim Übersetzen einer
Dokumentation kopiert man die Stückliste der Ausgangssprache
in den gewünschten Sprachenordner hinein. Das System sucht
nun nach allen bereits übersetzten Modulen und filtert die
nicht übersetzten Module heraus.
Fazit
Microsoft Word kann ein durchaus starkes und leistungsfähiges
Werkzeug im Bereich der technischen Dokumentation sein. In Verbindung
mit einem Redaktionssystem können wie dargestellt sämtliche
Vorteile genutzt und die Dokumentationen dennoch auf professionelle
und effiziente Art und Weise erstellt werden.
Leserbrief
schreiben
|
