RS #001 Übersicht von Software für technische Dokumentation – Adobe InDesign

Diese Folge stellt eine Übersicht von möglichen Softwareprodukten für die Erstellung von technischer Dokumentation dar. Begonnen wird mit Adobe InDesign.

Unsere neue Reihe beschäftigt sich mit  Softwarelösungen für die technische Dokumentation. Ich möchte in dieser Reihe verschiedene Tools vorstellen, die in der Welt der technischen Dokumentation genutzt werden. Ich werde in diesem Zuge einige Vor- und Nachteile der jeweiligen Programme nennen und meine persönliche Meinung dazu äußern.

Aktuell plane ich nicht auf spezielle Software im Detail einzugehen. Beispielsweise werde ich Redaktionssysteme als gesamtes behandeln. Eine genaue Betrachtung einzelner Software und Hersteller mach ich nur, falls Sie, liebe Zuhörer sich dies wünschen sollten. Sollte es also von Ihnen gewünscht werden, schicken Sie mir dies bitte per E-Mail.

Ich habe mich dazu entschieden, da diese Systeme oft komplex sind und es auch eine Vielzahl unterschiedlicher Software und Anbieter gibt. Dies würde bei weitem den Rahmen dieser Themenreihe sprengen. Auch möchte ich an dieser Stelle gleich anmerken, dass ich keine Werbung für einzelne Anbieter mache und es meine eigene, persönliche Meinung ist.

Außerdem möchte ich ergänzen, dass es immer gut ist, sich gründlich vor einer Einführung einer neuen Software zu informieren. Je nach Situation können einzelne Programme im Detail weniger oder besser geeignet sein. Dies kommt jedoch auf Ihre jeweilige, betriebliche Situation an.

So, genug zu diesen allgemeinen Aussagen und zurück zum Thema der Reihe. Mein Ziel ist es, dass Sie, liebe Zuhörer ein wenig Gefühl dafür bekommen, auf was man bei der Auswahl der Software vor der Erstellung der technischen Dokumentation achten sollte bzw. auch wie es andere Hersteller und Produzenten in den einzelnen Branchen handhaben.

Denn eine Anschaffung von Softwarelösungen ist und bleibt mit Kosten verbunden. Auch wenn man eine günstige Lizenz anschafft, können die verschiedenen Lösungen ihre Tücken haben.

Neben den gerade erwähnten Redaktionssystemen möchte ich im Zuge dieser Reihe auch auf Programme wie Adobe InDesign, Microsoft Word oder Content-Management-Systeme im Allgemeinen eingehen. Einfach um Ihnen Vor- und Nachteile aufzuzeigen.

In unserer ersten Folge möchte ich das Programm Adobe InDesign besprechen. Einige von Ihnen werden es kennen. Es ist ein Programm, das hauptsächlich in Marketing-Abteilungen eingesetzt wird, da es sich gut für die Gestaltung von Flyern eignet. InDesign erlaubt eine gute grafische und textliche Gestaltung der Dokumente.

Aufgrund dieser Eigenschaften wird das Programm auch gerne für die Erstellung der technischen Dokumentation verwendet. Falls sich einem von Ihnen bei diesem Gedanken nun die Haare sträuben, es ist nicht so schlimm wie es sich anhört. Betriebs- und Gebrauchsanleitungen können durchaus gut in diesem Programm erstellt und verwaltet werden.

In meiner Zeit als technischer Redakteur habe ich bereits einige gut gemachte Anleitungen in InDesign gesehen und prinzipiell spricht auch nichts dagegen, dort die Dokumente zu erstellen. Jedoch ist dies in InDesign ganz ähnlich wie in Microsoft Word. Die Redakteure müssen Kenntnisse des Programmes haben und wissen was sie tun. Einfach nur darauf los schreiben, ist nicht sinnvoll.

Wenn wir schon bei den Hacken sind. Welche Nachteile hat InDesign meiner Meinung nach? Ich beginne mit den gerade erwähnten Kenntnissen. Auch wenn dies meiner Meinung nach kein Nachteil für InDesign sondern für alle Programme ist. Der Benutzer sollte wissen was er tut. Einfach darauf los schreiben oder arbeiten macht prinzipiell keinen Sinn. Denn nur wenn man weiß was man tut, lässt sich eine gute Betriebs- und Gebrauchsanleitung erstellen.

Ein weiterer Nachteil aus meiner Sicht ist die Handhabung von Text und Bildern in InDesign. InDesign ist darauf ausgelegt, dass Bilder und Text an fixen Stellen angezeigt werden. Fall jemand von Ihnen InDesign nicht kennt, eine kurze Erklärung. In InDesign werden die Texte und Bilder meist über Textfelder platziert. Diese können wie in Word auf den leeren Seiten platziert werden. Durch die Größe des Feldes wird die Anzeige des Textes geregelt. Leider wird der Text ausgeblendet, der nicht in das Feld passt. Das Programm zeigt dies aber über eine Meldung an.

An dieser Stelle möchte ich anmerken, dass ich die Funktion kenne, um Textfelder zu verketten. Dann läuft der Text im nächsten Textfeld weiter. Aber diese Funktion hilft meiner Meinung nach nicht wirklich. Denn als Redakteur möchte ich meist Bild und Text zusammen haben. Wird der Text länger und verschiebt sich, dann muss ich alle meine Felder überprüfen, ob noch der Text dort angezeigt wird, den ich dort haben möchte.

An dieser Stelle bleiben wir noch bei den Textfeldern. Denn ein weiterer Nachteil ist die Fremdsprache für Dokumente. Sobald man ein Dokument mit verketteten Textfeldern übersetzt, muss es wieder genauestens geprüft werden. Je nach Sprache dann aber auch von einem Übersetzer. Denn der Redakteur kann ja nicht unbedingt alle Sprachen.

Wie viele von Ihnen wissen, kann sich die Textlänge nach der Übersetzung in andere Sprachen ändern. Je nach Ausgangs- und Zielsprache kann der Text länger oder kürzer werden. Englisch läuft zum Beispiel rund 15-20% kürzer als Deutsch. Französisch hingegen rund 20% länger als Deutsch. Und diese beiden Sprachen werden oft benötigt. Und genau dies muss bereits auch bei der Erstellung im deutschen berücksichtigt werden. Denn ansonsten wird die Anpassung nach der Übersetzung aufwendig.

Da wir thematisch bereits bei den verschiedenen Sprachen sind, möchte ich hier auch gleich den nächsten Nachteil benennen. Genaugenommen ist dies ebenfalls kein Nachteil des Programmes sondern der Arbeitsweise der Redakteure. Es geht um die Verwaltung mehrerer Sprachen. Oft bekommen wir InDesign-Dokumente, in denen über die verschiedenen Ebenen die einzelnen Sprachen dargestellt werden. Es gibt eine Ebene für Deutsch, eine Ebene für Englisch usw.

Über das Ein- und Ausblenden von Ebenen versuchen die Ersteller der Dokumente die Verwaltung und Handhabung der Fremdsprachen einfach zu handeln. Es ist ja alles in einer Datei. Aber der Hacken kommt dann, wenn weitere Sprachen dazukommen sollen. Nehmen wir mal beispielsweise an, dass eine Betriebsanleitung 30 Seiten umfasst und aktuell 2 Ebenen für Englisch und Deutsch besitzt. Alles ist so ausgerichtet, das es passt und die Texte in beiden Sprachen an den korrekten Stellen steht.

Nun wird von der Geschäftsführung beschlossen, dass der französische Markt erschlossen wird. Folglich benötigt man nun eine französische Anleitung. Daher haben wir nun die folgenden Probleme:

1. Das Dokument ist in einer Datei deutsch und englisch. Für die Übersetzung benötigen wir nur eine Sprache. Die andere muss aus dem Dokument entfernt werden, damit die Wörter nicht doppelt berechnet werden. Nach der Übersetzung müssen die drei Sprachen wieder in eine Datei eingepflegt werden. Das ist umständlich und kostet Zeit.
2. Die Datei ist bisher für Deutsch und Englisch ausgelegt. Zur Erinnerung Englisch läuft etwa 15% kürzer als Deutsch. Nun kommt Französisch dazu, das 20% länger als Deutsch läuft. Sprich etwa 35% länger als Englisch. Das bedeutet wir müssen alle drei Sprachen prüfen. Sollten wir kein Französisch sprechen können, benötigen wir einen Übersetzer dafür. Und so entstehen unnötige Kosten.

Ich finde dieses Beispiel zeigt klar dieses Problem der Arbeitsweise. Ich habe es als Nachteil für InDesign gewertet, da diese Arbeitsweise in anderen Programmen nicht möglich ist bzw. das Problem dort gar nicht auftauchen kann.

Zu guter Letzt ein im Vergleich kleiner Nachteil von InDesign. Große und umfangreiche, technische Dokumentationen benötigen verschiedene Verzeichnisse wie Tabellenverzeichnisse, Inhaltsverzeichnisse, Abbildungsverzeichnisse, Glossare und Indexe.

Die Gestaltung und der Einsatz von mehreren, verschiedenen und vor allem automatisch generierten Verzeichnissen in InDesign ist erfahrungsgemäß etwas schwerer und benötigt im Vergleich zu anderen Softwarelösungen erhöhte Benutzererfahrungen und Kenntnisse.

Kommen wir von den Nachteilen zu den Vorteilen. InDesign bietet abseits dieser Nachteile einige Vorteile, gerade auch in Verbindung mit anderen Adobe Produkten. Ich beginne mit einer Funktion, die ich gerade im Datenaustausch mit Kunden liebgewonnen habe. Es handelt sich um die Funktion „Packen“ oder „Verpacken“.

Diese Funktion dient für den Datenaustausch. Wird eine Datei mit dieser Funktion verpackt, packt InDesign automatisch alle eingebetteten Schriften und Bilder zusammen mit der Datei und auf Wunsch eine PDF-Datei in einen Ordner. Dieser Ordner kann gezippt und versendet werden. Der Empfänger bekommt alle Daten und es wird bei ihm alles korrekt angezeigt.

Ich sehe dies als großen Vorteil, da ich oft bereits den Fall hatte, dass Bilder bspw. in Word nicht eingebettet und nur verknüpft waren. Beim Empfänger werden die Bilder somit nicht mehr angezeigt und im schlimmsten Fall kann er die Datei so nicht verwenden. Das Einbetten der Bilder macht die Worddatei im Gegensatz dazu einfach nur groß. Ähnlich verhält es sich bei den Schriftarten. Sind Schriftarten beim Empfänger nicht vorhanden, werden sie in der Regel durch Standard-Schriftarten ersetzt. Und dadurch geht das Layouten der Daten von vorne los.

Neben der Verpackungsfunktion schätze ich an InDesign die Möglichkeiten der grafischen Gestaltung. InDesign erlaubt hier wesentlich mehr Möglichkeiten im Vergleich zu anderen Programmen. Vermutlich ist dies auch der Grund warum es gerne in Marketing-Abteilungen verwendet.

Der Einsatz von Farbverläufen oder ähnlichen Funktionen erlauben dem Redakteur eine ansprechende Gestaltung der Betriebs- und Gebrauchsanleitung. Ein großer Vorteil meiner Meinung nach, den solche Dokumente lese ich lieber als schwarz-weiße, Bild arme Textbände.

Zudem erlaubt InDesign in gewisser Weise die Bearbeitung von Bildern. Es ist kein Problem Bilder in InDesign zu vergrößern oder an Ausschnitte heran zu zoomen. So können Bilder ohne die Bearbeitung der Quelldaten an die Dokumentation angepasst werden.

Ein weiterer, aus meiner Sicht wichtiger Vorteil von InDesign ist die Handhabung von Quelldateien. Alle in das InDesign-Dokument verknüpften Dateien können aus InDesign heraus zur Bearbeitung geöffnet werden. Dadurch spart sich der Redakteur die Zeit, die Daten auf dem Server, Ablagesystem oder sonst wo suchen zu müssen.

Der Redakteur öffnet einfach das Fenster Verknüpfungen und kann über ein Menü auf ein verknüpftes Bild die Datei beispielsweise in Photoshop zur Bearbeitung öffnen. Im Anschluss ist es außerdem möglich, das Bild im gesamten Dokument zu aktualisieren. So können schnell und einfach Piktogramme und Symbole ausgetauscht werden. Zum Beispiel, wenn Sie Ihre ISO-Piktogramme durch ANSI-Piktogramme austauschen möchten.

Zu guter Letzt gefällt mir die Handhabung von Formatvorlagen in InDesign sehr gut. Denn diese können einfach Im- und Exportiert werden. So ist es ohne weiteres möglich, Formatvorlagen aus einem aktualisierten Dokument zu exportieren und in anderen Dokumenten zu übernehmen.

Ich hatte den Fall vor einigen Jahren, als ein Kunde seine Schriftart austauschen musste. Seine Hausschrift konnte keine Sonderzeichen darstellen. Also mussten die Dokumente auf Arial umgestellt werden. Aufgrund der guten Pflege der Formatvorlagen konnte diese Änderung in einem Dokument durchgeführt werden und dann diese Formatvorlagen exportiert werden. Sie wurden in den anderen Dokumenten importiert und innerhalb kurzer Zeit waren die Dokumente umgestellt.

Dies benötigt jedoch eine gute Pflege der Formatvorlagen. Diese müssen alle korrekt bezeichnet und sorgfältig gepflegt werden. Nur so werden die Formatvorlagen beim Import auch korrekt erkannt und beispielsweise überschrieben. Wäre in dem Beispiel dies nicht so gewesen, hätten die Formatvorlagen einzeln geprüft und umgestellt werden müssen und die Zeitersparnis wäre weggefallen.

Bevor ich zu meinem Fazit komme, möchte ich noch etwas zu den Vor- und Nachteilen anmerken. Ich habe die Wiederverwendung und Arbeitserleichterung bei InDesign nicht als Vor- bzw. Nachteil bewertet und bewusst ausgelassen. Dies werde ich ebenfalls bei Word und anderen Softwarelösungen so machen.

Diese Programme sind nicht für die Wiederverwendung und Arbeitsersparnis von Texten entworfen. Es kann zwar über Funktionen erzwungen werden, jedoch ist dies aus meiner Sicht nicht praktikabel. Daher werde ich diesen Punkt bei Redaktionssystemen und Content-Management-Systemen erwähnen, jedoch nicht als Nachteil für andere Programme werten.

Sollten Sie also viele, ähnliche Produkte herstellen oder vertreiben und Anleitungen dafür benötigen, kann ich Ihnen an dieser Stelle bereits die Verwendung eines Redaktionssystems oder ähnlicher Software empfehlen. Aber weiteres dazu kommt dann in der entsprechenden Folge.

Aber zurück zu InDesign und meinem Fazit: InDesign eignet sich meiner Meinung nach durchaus für die Erstellung von technischer Dokumentation. Jedoch hauptsächlich für Dokumente, die nur in wenigen Sprachen erstellt und grafisch aufwändig gestaltet sind. Von einer Verwaltung mehrerer Sprachen in einzelnen Dokumenten rate ich hingegen aus Sicht weiterer Spracherweiterungen ab. Hier ist der Aufwand zu hoch, umso mehr Sprachen in einem Dokument vorhanden sind.

Des Weiteren müssen Sie bei InDesign genau wie bei jeder anderen Software bedenken, in wie weit die diese bei Ihnen im Hause verbreitet ist und wer überhaupt Kenntnisse in der Bedienung hat. Auch hier kann ich Ihnen einen Praxisfall nennen. Abteilung A hat uns mit der Erstellung einer grafisch aufwändigen Anleitung beauftragt. Explizit wurde die Erstellung in InDesign gewünscht.

Abteilung B möchte einige Jahre später ebenfalls von uns diese Dokumente, jedoch in Word zur weiteren Bearbeitung. Denn dort war kein InDesign und niemand kannte sich mit InDesign aus. Und nun musste ein Kompromiss gefunden werden, da Word die grafische Darstellung von InDesign nicht leisten konnte. Entsprechend wichtig ist daher meiner Meinung nach die Entscheidung und Auswahl der Software.