Dossiers >> InDesign >> Fachartikel >> Mit InDesign dokumentieren
Artikel als PDF

Mit InDesign dokumentieren

Andreas Gronem ist Leiter einer technischen Redaktion und Dozent für Unternehmens­kommunikation und technische Dokumentation. Er arbeitet täglich mit InDesign.

Haeme Ulrich Andreas Gronem ist Redaktionsleiter bei Knick in Berlin. Knick ist weder eine Zeitung noch ein Magazin. Knick stellt elektronische Messgeräte her. Die Redaktion von Knick ist zuständig für die Erstellung und die Pflege von Produktbegleitmaterial, sprich Gebrauchsanweisungen.

Knick steht seit mehr als einem halben Jahrhundert für Qualität in der Herstellung von elektronischen Messgeräten und ist in vielen Spezialbereichen der Mess- und Regeltechnik Marktführer. Produkte des Berliner Unternehmens kommen unter anderem in der chemischen Industrie, in der Biotechnologie, im Anlagenbau und in der Industrie­automatisierung zur Anwendung.

Technischer Redaktor

Für gute Dokumentationen sind technische Redaktoren zuständig, echte Profis mit viel Engagement und Einfühlungsvermögen für die Endanwender.

InDesigner Andreas Gronem unterrichtet neben seiner Tätigkeit als Redaktionsleiter an der Technischen Universität Chemnitz Unternehmenskommunikation und technische Dokumentation. Er engagiert sich seit Jahren für den Beruf des technischen Redaktors. Er liess sich 1994, als er in einem amerikanischen Unternehmen tätig war, zum Technical Writer ausbilden. Damals gab es diese Ausbildung im deutschsprachigen Raum noch nicht. Die Fachverbände Tekom (D) und Tecom (CH) haben in den letzten Jahren den Beruf des technischen Redaktors etabliert.

Zum technischen Redaktor lassen sich meist Leute aus technischen Berufen weiterbilden, die bereits über das notwendige Hintergrundwissen verfügen.

Damit diese am Ball bleiben, organisiert die Tekom (www.tekom.de) jährlich zwei Fachmessen. Auch an der swiss publishing week wird die technische Dokumentation thematisiert.

Printlastig, weil gewünscht

Produktbegleitmaterial von Knick ist mehrheitlich gedruckt, dies entspricht der Nachfrage des Marktes. Das Internet kommt ergänzend zum Einsatz, wenn Bewegungen visualisiert werden sollen.

Die Arbeit von Andreas Gronem teilt sich auf in 30 Prozent Entwicklung neuer Dokumentationen und 20 Prozent Organisatorisches. Dazu gehören das Koordinieren und Steuern von Abläufen und Projekten. Die übrigen 50 Prozent investiert Andreas Gronem in die Pflege bestehender Dokumentationen und die Erarbeitung von OEM/PL-Adaptionen (siehe Fachbegriffe).

«Ich liebe die Herausforderung, etwas Hilfreiches zu tun und dabei bekannte Ansätze ständig neu zu überdenken. Ich geniesse ganz einfach die wunderbare Position zwischen Kunden und Marketing im Interesse des Anwenders», beschreibt Gronem begeistert, was ihn an seinem Beruf reizt.

Insiderwissen über die eigenen Produkte ist nicht vorrangig: «Die Produkte soll ich nicht im Schlaf kennen. Ich muss den Benutzer kennen, mich in seine Situation versetzen, um optimale Dokumentationen zu schreiben.» Daher ist Andreas Gronem auch oft mit Aussendienstmitarbeitern unterwegs, um den Puls der Endanwender zu fühlen.

Layouttipps

Die wenigsten Anwender studieren gerne Dokumentationen. Dies, weil Dokumentationen vom Aufbau her häufig komplett am Ziel vorbeischiessen. Dabei wäre es einfach: «Der Mensch ist keine Maschine. Dokumentationen müssen ansprechend und logisch aufgebaut sein. Darum sind gute Dokumentationen layoutgetrieben», fasst der Profi zusammen, «auf einer Doppelseite muss alles Wichtige drauf sein. Eine ansprechende Dokumentation enthält viel Bildmaterial. Hilfreich ist auch ein clever aufgebauter Index für die schnelle Suche.»

Die eiserne Regel bei Knick: Bei mehrsprachigen Dokumentationen ist in allen Sprachen auf derselben Doppelseite der gleiche Inhalt zu finden. Damit können sich Leute mit unterschiedlichen Sprachen über das gleiche Produkt sinnvoll austauschen.

Auf die Frage, was er von der Hilfe in InDesign-Hilfe halte, antwortet er kurz und bestimmt: «Extrem textlastig und fragwürdige Stichwortwahl.»

Bleistift vor InDesign

Dass Gronems Beruf kreativ ist, beweist die Entstehungsgeschichte einer Dokumentation. Zuerst entscheidet er, wie eine Funktion beschrieben werden soll. Dabei hält der Profi stets den Fokus des Anwenders im Hinterkopf. Er überlegt sich, welche Darstellungsform geeignet ist. Darauf folgen ein Bleistift-Scribble und schliesslich die Umsetzung in InDesign.

InDesign, nicht FrameMaker

Adobe InDesign wurde bei Knick nicht zufällig als Software für die technische Redaktion gewählt: «InDesign ist die einzige Applikation, mit der wir Dokumentation auf sinnvolle Weise und layoutgetrieben erarbeiten können», begründet Andreas Gronem den Entscheid. Adobe FrameMaker, die Software, die in der Automobilindus­t­rie häufig zum Einsatz kommt, ist für Andreas Gronem keine Alternative: «Arbeiten mit FrameMaker bedeutet immer einen enormen Initialaufwand. Man muss so viel in Prototypen stecken, dass es sich bei layoutgetriebener Dokumentation schlicht nicht rechnet. Zum Prototyp gehört natürlich auch die Entwicklung einer DTD (Document Type Definition) zur Sicherstellung der XML-Struktur. Bei InDesign ist mit der Entwicklung des Prototyps gleich auch das fertige Produkt gemacht. Für InDesign spricht auch der geringere Schulungsaufwand. Freelancer können wir dadurch einfacher in die Redaktion einbinden.»

Varianten über Daten­zusammenführung

Eine der bei Knick am häufigsten benutzten InDesign-Funktionen ist die Datenzusammenführung. «Über die Datenzusammenführung managen wir die unterschiedlichen Varianten der Dokumentationen», erklärt Andreas Gronem, «wir tauschen dabei Bilder und Textbausteine aus. Was ziemlich hemdsärmelig tönt, reicht in der Praxis aber absolut aus.» Knick pflegt pro Dokumentationsvariante eine CSV-Datei mit Textbausteinen und Filenamen der Grafiken. In der InDesign-Datei werden die Platzhalter der Datenzusammenführung eingefügt. Pro Dokumentationsvariante wird dann eine CSV-Datei jeweils mit dem InDesign-Dokument verbunden.

Bei Knick freut man sich auf die Umstellung auf InDesign CS4. Der bedingte Text soll die Datenzusammenführung sinnvoll ergänzen.

Andreas Gronems liebste InDesign-Funktion ist das InDesign-Buch. Pro Produkt, das beschrieben wird, entstehen bei Knick bis zu zweihundert InDesign-Dokumente, die in einem InDesign-Buch zusammengefasst werden. Schliesslich wird ein Index über das ganze Buch erstellt. Auf die Frage, was ihm denn in InDesign noch fehle, antwortet er zufrieden: «Mit den Querverweisen und dem bedingten Text wurden unsere grossen Wünsche mit CS4 erfüllt. Sonstige fehlende Funktionen decken wir mit Dritthersteller-Plug-ins ab. Genial an InDesign sind die offenen Schnittstellen. Dadurch ist ein grosser Plug-in-Markt entstanden, der auch spezielle Bedürfnisse abdeckt.»

Workflow-Organisation

Heute werden professionelle Übersetzungen über Translation Memory Systems (TMS) gemacht. Sehr verbreitet ist da die Software Trados, die auch bei Knick eingesetzt wird. Das Tolle bei Trados ist die nahtlose InDesign-Integration. So können InDesign-Anwender ihre Layouts für die Übersetzung als INX exportieren. Die Übersetzer öffnen das INX in Trados, übersetzen den Text und speichern das Dokument wieder als INX. Das übersetzte INX-File kann mit einem Doppelklick in InDesign geöffnet werden.

Ein Redaktionssystem ist bei Knick nicht im Einsatz, dafür ist das Team zu klein. Die Verwaltung der InDesign-Dokumente geschieht über das Warenwirtschaftssystem. Dabei verwenden die Mitarbeiter schlüssige Dateinamen, beginnend mit der Produktnummer. Der Upload in das System erfolgt ortsunabhängig über FTP.

Zur Vereinheitlichung der Arbeitsweise existieren Erstellungsanweisungen: «Darin beschreiben wir von A bis Z, wie bei der Erarbeitung von Standardhandbüchern vorzugehen ist», erklärt Andreas Gronem. Für jeden Dokumentationstyp gibt es eine solche Anweisung.

Automation – nur wenn es Sinn macht

Zur automatisierten Produktion hat Andreas Gronem eine gesunde Einstellung: «Grundsätzlich bringt die automatisierte Dokumentationserstellung dem Leser nichts. Automation darf somit nie Abstriche in der Qualität rechtfertigen.» Dass Gronem und sein Team sinnvoll rationalisieren, zeigt der intensive Einsatz von InDesigns Datenzusammenführung.

Auch über die Datenmehrfachnutzung hat sich Andreas Gronem schon intensiv Gedanken gemacht: «Bei uns ist Single Source Publishing schwierig umzusetzten, da wir im Web und im Print eben nicht die gleichen Inhalte wollen. Diese sollen sich ergänzen.»

Fazit

Die technische Redaktion ist heute fester Bestandteil der InDesign-Welt. Neue InDesign-Funktionen für lange Dokumente erleichtern den Alltag von technischen Redaktoren. Ein stetiger Trend «weg von Word oder Frame­Maker, hin zu InDesign» ist zu beobachten. Wer sich dabei Gronems Motto «Bekannte Ansätze ständig neu überdenken» zu Herzen nimmt, kann nicht falschliegen.

Fachbegriffe

Produktbegleitmaterial Bedienungsanleitung, Dokumentation.

Produkt Dafür wird die Dokumentation gemacht. Bei Knick Messgeräte.

Version Ständige Weiterentwicklungen der Produkte bedingen neue Versionen (Updates) der Dokumentationen.

Variante Produkt in mehreren Ausführungen/Versionen, zum Beispiel billig bis exklusiv. Notwendig bei OEM-Varianten der Produkte.

OEM/PL-Adaption (Original Equipment Manufacturer/Private Label) Notwendig, wenn ein Produkt unter verschiedenen Markennamen gehandelt wird.

«InDesign User Premium»

«InDesign User Premium» bietet für InDesign-Anwender eine besondere Plattform für Community-Aktivitäten und umfangreiche Informationen zu InDesign. Das nächste InDesign-User-Treffen findet im Rahmen der swiss publishing week am 7. September 2009 statt. Verpassen Sie auf keinen Fall die grosse Party «10 Jahre InDesign» und sichern Sie sich als Mitglied von «InDesign User Premium» ausgezeichnete Konditionen für die swiss publishing week (www.swiss-publishing-week.ch). Werden Sie Mitglied unter

www.indesign-user.org

Artikel als PDF