Die Anleitung zum Anleitungsschreiben – Redaktionsleitfaden und Styleguide sparen Kosten

 

Hinweis: Transline bietet einen Redaktionsleitfaden für Übersetzungsgerechtes Schreiben. 

Der technische Redakteur schreibt eine Bedienungsanleitung – leider meist nur für andere. Dabei könnte er sich mit seinen Fähigkeiten häufig genug selbst am Zopf aus dem Alltagssumpf ziehen: „Wie habe ich das denn neulich schon mal gemacht?“

Der Redaktionsleitfaden beantwortet die Fragen des Arbeitsablaufs, während der Styleguide Struktur und Aussehen der erzeugten Dokumente definiert.

 

Inhalte

 

• Warum Dokumentation dokumentieren?

• Redaktionsleitfaden: Wie viel oder wenig?

• Redaktionsleitfaden: Über das „Wie“

• Styleguide: Über das „Was“

• Fazit: Wir sind Konstrukteure, keine Künstler

 

Warum Dokumentation dokumentieren?

Zu den besonders interessanten Aspekten unseres Berufs gehört seine Vielseitigkeit. Zumeist arbeitet ein technischer Redakteur quer zu den üblichen Strukturen eines Industriebetriebs: Der Zeitplan kommt vom Projektmanagement, die Fachinformationen aus der Entwicklung, die Ersatzteilliste vom Kundendienst und das Titelbild aus der Marketingabteilung. Überall muss man seine Ansprechpartner kennen, überall trifft man auf unterschiedliche Nomenklaturen und Infrastrukturen. Zumeist haben die einzelnen Redakteure ihr Detailwissen im Kopf. Hoffentlich weiß wenigstens ein weiterer Kollege zumindest ungefähr, wie der Hase läuft.

Aber niemand weiß das alles so ganz genau. Entsprechend probiert man immer wieder aus, wie man die Grafikdatei vom Mac mit einem Auszug aus einer CAD-Zeichnung verheiratet. Schließlich macht man das nur alle paar Wochen, wenn wieder mal ein neues Titelblatt erstellt werden muss.

Vergleichbare Probleme gibt es überall in der Wirtschaft. Unter anderem deswegen wurden die Qualitätsnormen ISO 9000ff entwickelt. Die fordern ein System von zu erstellenden Unterlagen, beispielsweise Arbeitsanweisungen. Spätestens jetzt sollte klar sein, dass wir hier von einem wichtigen Thema reden: preiswerte, konsistente Qualität.

Leider ist es sehr schwer, an solche Arbeitsanweisungen oder Leitfäden heranzukommen. Das ist kein Wunder, denn in diesen Unterlagen stecken viel Arbeit und Wissen. Anders als bei Styleguides, Glossaren oder Normungsarbeit hat man hier auch keine Chance, die eigene Branche näher an die firmeninterne Übung heranzuführen. Man machte damit nur die Konkurrenz schlau. Also ist in weiten Grenzen selber machen angesagt.

 

Redaktionsleitfaden: Wie viel oder wenig?

Auch wenn wir vom Schreiben leben, konsumieren wir unsere eigenen Produkte kaum anders als unsere Umgebung: Reizüberflutung und Zeitknappheit führen dazu, dass wir Anleitungen, Beschreibungen oder auch den Redaktionsleitfaden nur im äußersten Notfall lesen. Erst wird ausprobiert, später vielleicht geblättert. Unser virtueller Benutzertest an uns selbst zeigt also, dass wir unsere eigenen Anleitungen und Leitfäden so knapp und so gut organisiert wie irgend möglich erstellen müssen - und dabei mit uns selber kämpfen ganz im Stil des alten Spruchs von den Schuhen des Schusters.

Eine Ausnahme gibt es vielleicht in Redaktionen mit viel Fluktuation: Ein neuer Kollege wird erst einmal gierig alles aufnehmen, was er an aufbereiteten Informationen bekommen kann. Dafür, dass jeder neue Kollege erst mal still auf seinen vier Buchstaben sitzen bleibt und einen nicht ständig aus der Konzentration reißt, kann man schon mal „ein paar Tage“ in einen Redaktionsleitfaden stecken.

Vor Jahren stellte eine Siemens-Manualredaktion ihren Redaktionsleitfaden auf einer tekom-Tagung vor. Dort war unter Anderem genau aufgeschlüsselt, welche Fähigkeiten der neue Kollege innerhalb des ersten halben Jahres zu erwerben habe. Die wohl reichlich 200 Seiten blieben bis heute der umfangreichste Redaktionsleitfaden, den ich in Händen hielt. Meiner Schätzung nach steckte in diesem Handbuch mindestens ein Mannjahr Arbeit, die sich in einer großen Redaktion aber schnell amortisieren dürfte.

Grundsätzlich sollten Redaktionsleitfäden und Styleguides folgende Bestandteile beinhalten:

Redaktionsleitfaden: Über das „Wie“

 

• Arbeitsanweisungen
• Formulare, Checklisten
• Beschreibungen von Vorgängen, Schnittstellen und so weiter

Styleguide: Über das „Was“

 

• Terminologie, Formulierungsvorschriften
• Dokumenttypen und -strukturen
• Gestaltungsdetails

 

Redaktionsleitfaden: Über das „Wie“

Die Vielfalt unseres Berufsfeldes macht es schwer, hier handfeste Angaben zu machen. Folgende Themen sollten aber einen Großteil der Fälle abdecken:

 

Arbeitsanweisungen

Vieles in der Arbeit ist Routine, über die man kaum noch nachdenkt. Spätestens wenn der Spezialist einmal krank ist, sind die Kollegen für eindeutige Schritt-für-Schritt-Anleitungen dankbar. Hier kann es etwa um ein Verfahren gehen, wie man CAD-Daten für die Anleitung aufbereitet. Oder auch um das Vorgehen, wen man wann, wie und mit welchen Unterlagen zu einer Redaktionskonferenz einlädt.

Solche Arbeitsanweisungen sollte ein technischer Redakteur eigentlich aus dem Ärmel schütteln können, während er die beschriebenen Arbeiten ausführt – zumindest dann, wenn er einen zweiten oder dritten Bildschirm dafür hat. Mir ist sowieso ziemlich unverständlich, wie ich mit einem einzigen Bildschirm ein Software-Handbuch schreiben sollte...

 

Formulare, Checklisten

Formalismen machen vieles leichter, speziell wenn man „unterbrechungsgesteuert“ arbeitet: Arbeitet man solch eine Unterlage von oben nach unten ab, wirft einen ein Anruf oder der Besuch eines Kollegen nicht mehr so aus der Bahn. Die Gefahr sinkt, dass man einen Schritt vergisst. Auch der Kollege bekommt eine Chance, diese Arbeit flott und fehlerfrei zu leisten. Füllt man tatsächlich ein Dokument aus, egal ob auf Papier oder am Bildschirm, dokumentiert man auch seine Arbeit. Datum und Uhrzeit drauf und schon fällt am Monatsende das Ausfüllen des Stundenzettels leichter. Solche Unterlagen sind auch höchst wertvoll, sollte es einmal zu einem Rechtsstreit wegen Instruktionsfehlern kommen.

Manche Checklisten und Formulare sollte man in der Firmenhierarchie möglichst hoch absegnen lassen. Gerade wenn man quer zur Firmenstruktur arbeitet, sitzt der gemeinsame Vorgesetzte häufig diverse Hierarchiestufen höher. Die passende Unterschrift wird so manchen unwilligen Kollegen zur Zusammenarbeit bewegen. Typische Beispiele sind Informationsbeschaffung oder Korrekturumlauf.

 

Beschreibungen von Vorgängen, Schnittstellen und so weiter

Schritt-für-Schritt-Anleitungen haben kurz und knackig zu sein, sonst nutzt sie keiner. Dabei fallen aber Hintergrundinformationen durchs Gitter, die für das Verständnis des Ablaufs oder seine Weiterentwicklung wichtig sind. Ich plädiere deshalb dafür, Abläufe getrennt zu beschreiben und zu erläutern. Der schon zitierte neue Kollege wird dafür höchst dankbar sein. Diese Beschreibungen sind auch wichtig, wenn man externe Kräfte einbinden muss – egal ob Dienstleister, Kollege aus anderer Abteilung oder Chef des eigenen Chefs, wenn der eine Handlungsanweisung gutheißen soll.

Hier kann man also beschreiben, wie sich die zeitlichen Abläufe in der Abteilung gestalten oder warum man bestimmte Daten in einer ganz bestimmten Form haben muss. Auch Querverbindungen zum Styleguide kann man hier unterbringen.

 

Styleguide: Über das „Was“

Die Zweiteilung in Redaktionsleitfaden und Styleguide mag ungewohnt sein, trägt aber zwei Entwicklungen Rechnung: einerseits den Qualitätsnormen wie ISO 9000ff und andererseits der immer komplexeren IT-Umgebung, in der wir arbeiten. Zu nennen sind hier inhaltlich strukturierende Systeme, meist auf Basis von SGML/XML, und Content-Management-Systeme wie in [1].

Die Internationalisierung wirkt sich durchaus zum Vorteil des technischen Redakteurs aus: Übersetzt man eine Anleitung in alle Amtssprachen der EU, spielen die Erstellungskosten der Urfassung keine wesentliche Rolle mehr. Eine sprachlich möglichst hochwertige und deshalb teuere Urfassung senkt die Gesamtkosten, weil das Übersetzen einfacher wird.

Im Gegensatz zu Redaktionsleitfäden sind Styleguides relativ leicht zu bekommen. Ganz wesentlich beteiligt sind hier Softwarehersteller wie Microsoft [2] oder Apple [3], denen an möglichst einheitlichen Programmoberflächen liegt. Der technische Redakteur ist spätestens dann mitten im Geschehen, wenn er Online-Hilfe schreibt oder die Terminologie der Programmoberfläche pflegt. Meine einschlägige Sammlung finden Sie unter [4].

Bei inhaltlich strukturierten Systemen hat der technische Redakteur mit dem Aussehen der Ausgabeinstanz nichts mehr zu tun. Das erleichtert seine Arbeit aber keineswegs: Ausdrucksweise, Auszeichnung und Struktur seiner Dokumente werden oft in mehrere 100 Seiten starken Wälzern wie [5] bis in die letzten Details definiert. Was hier entsteht, gleicht mehr einem Computer-Datensatz als einem herkömmlichen Dokument.

 

Die Basis: Terminologie

Für die Entwickler völlig fremd und für viele Kollegen immer noch exotisch ist die Forderung nach einheitlicher Terminologie. Technische Redakteure aus der Ingenieurecke werden hier eher Probleme haben als ihre geisteswissenschaftlichen Kollegen. Das Thema ist sicher eigene Fachbeiträge wert.

Terminologie wird häufig während der Produktentwicklung geboren, und das in unterschiedlichen Arbeitsgruppen immer wieder neu. Wer, außer dem technischen Redakteur, sollte hier koordinierend und steuernd eingreifen? Wenn inkonsistente Bildschirmgestaltung den Nutzer zur Verzweiflung treibt, ist es zu spät. Die Terminologieentwicklung wird so zur eindeutigen Aufgabe des technischen Redakteurs und das Arbeitsergebnis zum zentralen Bestandteil des Styleguides.

Ein typisches Beispiel, was beim Fehlen entsprechender Koordination passiert, sind die SAP-Systeme vieler Firmen. Auf Anforderung der Fachabteilung ändert ein Anwendungsentwickler stehend-freihändig eine Maske oder baut eine neue ins System ein – mit entsprechenden Auswirkungen auf Konsistenz der Programmoberfläche und der darin enthaltenen Terminologie.

Terminologiearbeit ist ein Langstreckenlauf, der vom Topmanagement unterstützt werden muss. Dafür müssen weit über die Redaktion hinaus Dienstwege angelegt werden. Die Verantwortlichen müssen regelmäßig über Aufnahme oder Ablehnung von Begriffen, ihre Definition und die verbindlichen Übersetzungen entscheiden. Abgelehnte Begriffe dürfen dann nirgendwo mehr auftauchen, weder in Handbuch noch Programmoberfläche oder Frontplattenbeschriftung. Wenn es überhaupt nicht anders geht, bekommt die Werbeabteilung etwas mehr Freiheit.

Terminologie gehört zu den Informationen, mit denen viele Firmen recht freigiebig sind. Damit kann man seine eigene Kompetenz nachweisen, eine Branche im eigenen Sinn beeinflussen oder ganz einfach den Suchmaschinen interessante Suchbegriffe anbieten. Meine Sammlung finden Sie unter [6]. Microsoft stellt riesige Wortlisten zur Verfügung [7], die allerdings linguistischen Ansprüchen nicht standhalten.

Wer Schreib- und Ausdrucksweisen normieren will, kann z.B. die Regelungen der Zeitung „Die Zeit“ [8] als Ausgangspunkt nehmen. Hier ist auch bemerkenswert, dass es eine recht umfangreiche Einführung gibt. Wie schon erwähnt sind Detailregelungen notwendig und sinnvoll. Zum sinnvollen Anwenden muss man aber auch etwas über die Hintergründe und Zusammenhänge wissen.

Terminologieleitfaden anfragen

 

Die Basisdefinitionen: Dokumenttypen und Dokumentstrukturen

Zu den zentralen Bestandteilen eines Styleguide gehört die Definition, welche Dokumenttypen in der Redaktion erstellt werden und in welchen Zusammenhängen sie jeweils benutzt werden. Das ist zu Beginn eines Projektes der zentrale Verteiler, welche Formularvorlagen, welche Dateinamen, welche Gliederungen, welche Formulierungen zu benutzen sind. Zwischen einer Werbeanzeige und einer kontextsensitiven Online-Hilfe wird es außer der Platzierung des Firmenlogos nur wenige Gemeinsamkeiten geben.

Logo links oder rechts auf die Titelseite? Das ist eine Frage, die ein Styleguide firmenweit klären sollte.

Sie gestalten keine Anzeigen? Dann wird es höchste Zeit, Ihren Styleguide mit dem der Marketingabteilung abzustimmen. Hieraus ergibt sich auch ein weiteres Argument für die Zweiteilung in Redaktionsleitfaden (Arbeitsanweisungen usw.) und Styleguide (Definition des Aussehens): Ihre Arbeitsmethoden werden die Marketing-Spezialisten wohl kaum interessieren.

 

Viele, viele Details

Der Styleguide enthält viele Detailinformationen, die dafür sorgen sollen, dass alle Ihre Dokumente zusammenpassen:

 

• Bausteine wie Adressen der Firmenvertretungen, allgemeine Warnhinweise, Rückseiten, Schrift- und Layoutdefinitionen usw. existieren tunlichst nur einmal.

• Konventionen für Dateinamen usw. handelt man wohl am besten zentral ab.

• Zielgruppendefinitionen wirken sich an vielen Stellen aus, sowohl bei der Wahl des Dokumenttyps als auch beim Formulieren.

Je weiter die maschinelle Unterstützung geht, um so genauer müssen auch die Vorgaben im Styleguide sein. Wenn die IT-Umgebung mit Hilfsmitteln wie Content Management oder inhaltlicher Strukturierung arbeitet, erstellt der technische Redakteur zunehmend kleine Bausteine. Dabei weiß er nicht, in welchen Medien und in welchen Zusammenhängen sein Text verwendet werden wird. Dieses Puzzle lässt sich nur dann in immer wieder anderen Formen zusammensetzen, wenn jeder Baustein genau den geplanten Inhalt hat.

 

Fazit: Wir sind Konstrukteure, keine Künstler

Vor langer Zeit arbeitete ein technischer Redakteur fast so wie ein Schriftsteller – handschriftlich, mit Diktiergerät oder mit Schreibmaschine. Heute gelten unsere Arbeitsergebnisse in vielen Fällen als Teil des Produkts. Dadurch wird unsere Arbeit zum Teil eines industriellen Entwicklungs- und Fertigungsprozesses. Unsere Arbeit wird immer arbeitsteiliger und vernetzter. Wir müssen unsere Produktivität immer mehr erhöhen – weit über das Maß hinaus, das man mit schneller Denken erreichen kann.

Unsere IT-Infrastruktur wird immer leistungsfähiger, aber auch unfähig, mit Ausnahmen umzugehen. Wir haben keine Kontrolle mehr über das Zielmedium. Ob es uns passt oder nicht: Wir stecken zunehmend in einem Geflecht, in dem wir uns ohne passenden Redaktionsleitfaden oder sonst einer Anleitung kaum noch zurechtfinden können.

Von Alexander von Obert

Leitfaden anfragen

 

Literatur:

 

• [1] Holk Traschewski: Der Produktionsprozeß bei Prokom. Präsentation für die tekom-Regionalgruppe Nürnberg, 2002. http://www.techwriter.de/thema/fremdedo.htm#prokom
• [2] The GUI Guide - International Terminology for the Windows Interface. Microsoft Press, 1993
• [3] Apple Developer Connection: Documentation
• [4] Hinweise für technische Redakteure http://www.techwriter.de/thema/hinweis1.htm
• [5] SAE J2008 (xmlxperts)
• [6] Wörterbuch- und Glossarliste http://www.techwriter.de/ue-portal/woerterb/
• [7] Microsoft-Glossare
• [8] ZEITschreibung: Anwendung der neuen deutschen Rechtschreibung in der Zeitung "Die Zeit".