Kleine Helfer in der Technischen Dokumentation: TANNER-doCom-Tool

Das zweite Tool in meiner Reihe zu “Kleine Helfer in der Technischen Dokumentation” ist das TANNER-doCom-Tool. Dieses Tool ist ein Dokumenten-Konfigurator, der Word-Dokumente – gesteuert von einer Excel-Liste – zu einem Dokument zusammenfügt. Damit kann unser kleiner Helfer deutlich mehr als die eingebaute Textbausteinfunktion von Word, ist aber kein Redaktionssystem á la Docuglobe. Unser Kunde und ich sind davon überzeugt: Genau das richtige Tool, wenn man nur wenige Male im Monat Word-Dokumente zusammenfügen muss.

Dokumenterstellung aus vielen Modulen schwierig

Möchte man von Fall zu Fall unterschiedliche Dokumente erstellen, die aus standardisierten, immer wiederkehrenden Inhalten zusammengestellt sein sollen, so kann es sinnvoll sein, die Inhalte zu modularisieren. Probleme können beim Versuch entstehen, aus einer großen Anzahl von Modulen schnell ein Dokument zusammenzustellen.

Da meist die Reihenfolge der Inhalte vorgegeben ist, gewisse Inhalte immer wieder vorkommen und gewisse Inhalte einfach nur durch andere ausgetauscht, eingesetzt oder nicht verwendet werden sollen, kann man von einer Makrostruktur – einem Master – ausgehen. So wird in einer Excel-Tabelle quasi das vollständige Inhaltsverzeichnis aufgelistet, also alle erstellten Module in ihrer richtigen Reihenfolge hintereinander gelistet. Im Falle von Optionen, also Inhalten, die vorkommen können oder nicht (Varianten bzw. Inhalte, die “entweder – oder” vorkommen), werden auch diese Module in die Liste aufgenommen.

Modularisierung: So viel wie nötig, so wenig wie möglich

Die Module selbst werden streng nach Redaktionsregeln erstellt, am besten basierend auf einer Word-Vorlage. Wie immer gilt auch hier die Regel, so viel wie nötig und so wenig wie möglich zu modularisieren, um den Überblick behalten zu können. Es bietet sich an, als kleinste Einheit nur Topics zu modularisieren, also Abschnitte mit einer Überschrift beginnend.

Ein Problem beim Modularisieren in Word stellen Querverweise dar. Wir haben deshalb bei der Programmierung des Tools auf die Buchfunktion von Word zugegriffen. Damit nutzen wir die Funktionalität von Word so umfassend wie möglich und sind zuversichtlich, dass der Anpassungsaufwand bei zukünftigen Updates gering bleibt.

Möchte man nun ein Dokument konfigurieren, steigt man in die Excel-Liste ein und zeichnet in einer separaten Spalte alle Module aus, die man verwenden möchte. Das TANNER-doCom-Tool wird nun aufgerufen. In einer Eingabemaske in Excel werden noch folgende Informationen abgefragt:

•    Quelle (Inputfolder)
•    Speicherort
•    Sprache

Das Tool liest nun die Excel-Liste, setzt die Word-Module nacheinander und kontrolliert, ob die Querverweise stimmen und auch zu einem existierenden Ort führen. Fehlermeldungen, zum Beispiel nicht-gefundene Grafik-Dateien, schreibt das Tool in ein Log-File.

Das Tool generiert nun ein Word-Dokument mit den ausgewählten Modulen. Abschließend muss dieses nur noch geöffnet und Felder, wie Inhaltsverzeichnis sowie Kopf- und Fußzeile, aktualisiert werden. Das Word-Dokument kann man anschließend noch weiter verarbeiten.

Modularisierungsstrategie vorab festlegen

Um das Tool nutzen zu können ist es hilfreich, bereits sauber in Worddokumenten zu schreiben – am besten basierend auf einer Word-DOT-Vorlage. Im Vorfeld bietet es sich an, eine Modularisierungsstrategie zu definieren, dauerhaft sollten die Module in einer Excelliste aufgelistet und gepflegt werden.

Nützlich ist das Tool vor allem bei kleinen Modularisierungsaufgaben, die eine Investition in ein CMS nicht rechtfertigen oder – wenn man modularisieren möchte – sich aber nicht für ein CMS entscheiden kann. Ein Redaktionssystem lohnt sich dann, sobald mehrere Redakteure, mehrere Sprachen, viele Varianten und Optionen zu händeln sind.

TANNER-doCom-Tool im Überblick:

• Word-Module mit gleichen Formatvorlagen und Layoutstrukturen
• Ideal basierend auf einer WORD-DOT
• Für Querverweise zu anderen Modulen ist die Word-Buch-Funktion nötig
• Sauberes Arbeiten ist in einer solchen Umgebung unabdingbar
• Nur Word und Excel als Lizenzen nötig

 Weitere Beiträge zu “Kleinen Helfern in der Technischen Dokumentation”:

• TANNER-PDF-Tool
• TANNER-Word-Vergleich
• TANNER-ETK-Tool