Technischer Redakteur vs. Technical Writer

Ich bin selbstständiger, freiberuflicher Technischer Redakteur und Technical Writer mit Schwerpunkt Softwaredokumentation im Großraum Nürnberg, Fürth, Erlangen und darüber hinaus. Redaktionssprachen Deutsch und Englisch.

Aber sind ein Technischer Redakteur und Technical Writer nicht dasselbe? Und wer braucht so einen Experten überhaupt? Diese Fragen werden mir leider immer noch zu oft gestellt.

Wer braucht einen Technischen Redakteur?

Kurz gesagt jedes Unternehmen, dem daran gelegen ist, dass seine Kunden die hergestellten und verkauften Produkte vollständig verstehen und sicher und zielführend verwenden können – ohne dabei den Support mit vielen Fragen zu belasten. Schreiben kann zwar jeder, aber nicht unbedingt jeder kann so schreiben, dass es am Ende auch jeder versteht. Nicht ohne Grund ist Technische Redaktion heute ein mehrjähriger Studiengang und kein Nebenjob für eine Aushilfskraft.

„Die Bombe ist mit einem roten und mit einem blauen Draht verbunden. Um die Bombe zu entschärfen, durchtrennen Sie diesen.“

Alles klar? Wirklich? Sind Sie sicher? Möchten Sie's versuchen?

Ein Technischer Redakteur beschreibt die Dinge eindeutig und unmissverständlich. Ausdrücklich auch dann, wenn dabei zum Beispiel einmal Wörter wiederholt werden müssen. Allem zum Trotz, was im Deutschunterricht gelehrt wurde!

„Die Bombe ist mit einem roten und mit einem blauen Draht verbunden. Um die Bombe zu entschärfen, durchtrennen Sie den roten Draht.“

Was macht ein Technischer Redakteur?

Als selbstständiger, freiberuflicher Technischer Redakteur und Berater für Technische Dokumentation konzipiere und erstelle ich im Auftrag meiner Kunden für deren Produkte verständliche Handbücher und Online-Hilfen. Unternehmen, die Ihre Dokumentation selbst schreiben, berate ich bei der Auswahl der richtigen Erstellungswerkzeuge und Prozesse. Außerdem schule ich die mit der Dokumentationserstellung betrauten Mitarbeiter darin, die zu vermittelnden Inhalte benutzerfreundlich zu strukturieren und verständlich zu beschreiben.

Was sind die häufigsten Fehler beim Erstellen von Benutzerhandbüchern?

Meist gehen Probleme im Zusammenhang mit einer Technischen Dokumentation auf eine der folgenden Ursachen zurück:

• Die Dokumentation entspricht der technischen Denkweise der Entwickler, spiegelt jedoch nicht die Fragen der Benutzer wider.
• Die Dokumentation beschreibt das, was die Benutzer ohnehin selbst am Produkt sehen. Stattdessen fehlt eine Erklärung dessen, was die Benutzer nicht sehen.
• Autoren versuchen, mit langen, komplexen Sätzen ihre intellektuellen Fähigkeiten zu beweisen und Texte quellen über von Fachbegriffen. Dabei wäre „einfach“ doch einfach einfacher!

Ich helfe Ihnen, diese und viele weitere Fehler zu vermeiden. Die Bedienung der meisten Produkte ist ohnehin komplex genug. Da sollte wenigstens die Bedienungsanleitung einfach und verständlich sein!

Meine Tätigkeiten als Technischer Redakteur und Technical Writer

Optimierung bestehender Dokumentation

Sie sind mit der Qualität Ihrer Technischen Dokumentation nicht mehr ganz zufrieden? Als Berater analysiere ich Ihre Dokumente auf Schwachstellen und erarbeite entsprechende Verbesserungsvorschläge.

Konzeption neuer Dokumentation

Haben Sie ein neues Produkt entwickelt und benötigen dafür noch eine Technische Dokumentation, beispielsweise ein Benutzerhandbuch oder eine Online-Hilfe? Auf Basis einer eingehenden Anforderungs- und Zielgruppenanalyse erarbeite ich als Berater ein benutzerfreundliches Dokumentationskonzept bis hin zu einem detaillierten Gliederungsentwurf Ihrer Dokumentation.

Erstellung von Handbüchern und Online-Hilfen

Sie benötigen nicht nur gute Ideen für eine Dokumentation, sondern auch jemanden, der diese Ideen umsetzt? Als erfahrener Technischer Redakteur erstelle ich für Sie alle Bestandteile Ihrer Technischen Dokumentation. Übrigens: Online-Hilfen und Benutzerhandbücher lassen sich mit geeigneten Autorensystemen aus einer gemeinsamen Textquelle heraus generieren. Die Inhalte müssen also nicht jeweils separat erstellt, doppelt gepflegt und möglicherweise mehrfach übersetzt werden. Ähnliches gilt für unterschiedliche Varianten einer Dokumentation, beispielsweise für eine „Lite-Version“ und eine „Professional-Version“ derselben Software (sog. Single-Source-Publishing).

Redaktionsleitfäden und Strukturvorlagen

Sie benötigen eine „Anleitung zur Anleitung“ – einen Leitfaden für Ihre Mitarbeiter, nach dessen Regeln einheitliche, konsistente Dokumente entstehen, unabhängig davon, wer diese Dokumente schreibt? Als Berater analysiere ich Ihre spezifischen Anforderungen und erstelle für Sie ein entsprechendes Regelwerk. Übrigens: Dieses Regelwerk wird so einfach und übersichtlich bleiben, dass es von den Mitarbeitern auch akzeptiert und genutzt wird.

Formatvorlagen (Templates)

Sie benötigen eine professionelle Formatvorlage (Template, Stylesheet) für ein Benutzerhandbuch oder für eine Online-Hilfe? Ich erstelle für Sie Formatvorlagen, die nicht nur gut aussehen, sondern die auch ergonomisch nutzbar sind. Sowohl für den Leser als auch für den Autor. Für den Leser bedeutet Ergonomie: Die Formatvorlagen sind so übersichtlich gestaltet, dass sie das Auffinden bestimmter Informationen einfach machen und dass es leicht fällt, das Gelesene nachzuvollziehen und zu behalten. Für den Autor bedeutet Ergonomie: Die Formatvorlagen sind so angelegt und strukturiert, dass sie im Redaktionsalltag einfach zuzuweisen und jederzeit zu ändern sind. Außerdem automatisieren die Formatvorlagen so viele Formatierungsschritte wie möglich.

Beratung bei der Auswahl von Redaktionssystemen

Sie sind auf der Suche nach einem geeigneten Werkzeug, um Ihre Technische Dokumentation effizient erstellen und pflegen zu können? Basierend auf meiner langjährigen Erfahrung und Branchenkenntnis berate ich Sie bei der Auswahl. Ich zeige Ihnen, welche Redaktionssysteme und Tools überhaupt infrage kommen, erläutere Ihnen deren jeweilige Vor- und Nachteile und weise Sie auch auf die Schwachstellen hin, die die Hersteller gerne verschweigen. Ich berate Sie objektiv und frei von jedem Verkaufsinteresse an einem bestimmten Produkt. Somit erhalten Sie eine fundierte Entscheidungsgrundlage und sparen viel Zeit für eine langwierige Vorauswahl.

Schulungen und Workshops

Sie benötigen neue Ideen, Feedback oder individuelle Unterstützung für sich selbst oder für Ihr Team? In Form individueller Schulungen und Workshops vermittele ich Ihnen die erforderlichen Grundlagen, zukünftig selbst hochwertige, verständliche und benutzerfreundliche Technische Dokumentation erstellen zu können. Wenn Sie bereits Erfahrung haben, unterstütze ich Sie gezielt in einzelnen Punkten. Spezielle Schulungen biete ich außerdem an zu den Redaktionssystemen (Help-Authoring-Tools) „MadCap Flare“ und „Help+Manual“.

Weitere Leistungen

Neben dem Kernbereich Konzeption und Erstellung Technischer Dokumentation unterstütze ich Sie bei Bedarf außerdem:

• beim Entwerfen verständlicher, fehlerfreier Texte für Benutzeroberflächen (sogenanntes UX-Writing und Microcopy)
• beim Schreiben von Texten für Websites und Broschüren
• beim Erstellen von Schulungsunterlagen
• beim Erstellen von Screencasts (Software-Videos)

Gibt es Unterschiede zwischen einem Technischen Redakteur und einem Technical Writer?

In Stellenanzeigen und auf Projektbörsen suchen Unternehmen häufig nicht nach einem Technischen Redakteur, sondern nach einem „Technical Writer“. Meist ist dies nur ein (vermeintlich) schick klingender Anglizismus für „Technischer Redakteur oder Technische Redakteurin“. Nur manchmal soll es zum Ausdruck bringen, dass im ersten Schritt tatsächlich eine englischsprachige Technische Dokumentation erstellt werden soll. Auch kann es ein Hinweis darauf sein, dass es sich bei den Aufgaben für die gesuchte Person primär um Softwaredokumentation handelt.

Schreiben englischer Texte

Der einfachste und transparenteste Grund für die Suche nach einem Technical Writer statt nach einem Technischen Redakteur ist, dass tatsächlich ein englischer Muttersprachler oder eine Person mit hervorragenden Englischkenntnissen gesucht wird, um auch wirklich englische Texte zu schreiben.

Bei international agierenden Unternehmen ist es teilweise durchaus auch im deutschen Sprachraum üblich, die Masterversion einer Dokumentation in englischer und nicht in deutscher Sprache zu erstellen. Gründe dafür können z. B. sein:

• In internationalen Teams wird zuerst eine englischsprachige Dokumentation benötigt.
• Die ersten oder die wichtigsten Kunden befinden sich außerhalb des deutschen Sprachraums.
• Die Dokumentation soll zukünftig in sehr viele unterschiedliche Sprachen übersetzt werden, unter denen sich möglicherweise auch vergleichsweise seltenere Sprachen befinden. Für solche Sprachen ist oft einfacher und kostengünstiger, Übersetzer mit Englisch als zweiter Sprache zu finden als mit Deutsch. (Anmerkung: Erst von Deutsch nach Englisch übersetzen zu lassen und dann im zweiten Schritt in die seltene Sprache ist keine gute Lösung, denn dies dauert durch den zusätzlichen Schritt länger und multipliziert mögliche Übersetzungsfehler.)

Softwaredokumentation

Im Bereich international vertriebener Software ist es ebenfalls häufig üblich, die Dokumentation zuerst oder sogar ausschließlich in englischer Sprache zu erstellen.

Auch ist allgemein die Software-Branche stark von der englischen Sprache geprägt – nicht zuletzt, weil alle Programmiersprachen auf englischen Befehlen beruhen und weil die meisten Entwicklerforen ebenfalls englischsprachig und die Entwicklerteams oft international verteilt sind.

Im Software-Umfeld kann es außerdem vorkommen, dass manche Dokumente auf Deutsch und manche Dokumente in Englisch geschrieben werden. Beispiel: Benutzerdokumentation auf Deutsch, Schnittstellendokumentation (API-Dokumentation) in Englisch.

Die Suche nach einem Technical Writer statt nach einem Technischen Redakteur soll dann kommunizieren, dass sich die betreffende Person auch in internationalen Teams bewegen können und beiden Sprachen mächtig sein muss.

Imagepflege

Schließlich gibt es noch den nicht seltenen Fall, dass der gesuchte Technical Writer niemals ein Wort Dokumentation in englischer Sprache verfassen wird. Man möchte sich als Unternehmen durch die englische Bezeichnung lediglich nach außen hin einen internationalen Anstrich geben.

Etwas sarkastisch formuliert: Gut möglich, dass der Technical Writer oder die Technical Writerin als High-Potential bei einem Global Player landet – on-site oder remote im Home-Office – wo er oder sie dann in Collaboration mit diversen anderen Stakeholdern in multidisziplinären Development-Teams Manuals schreibt, bei denen außen zwar User Guide draufsteht, aber letztlich auch nur ein schnödes Benutzerhandbuch drin ist …

Ein „Technical Writer“ macht also im Wesentlichen genau dasselbe wie ein Technischer Redakteur und schreibt in erster Linie Benutzerhandbücher, Online-Hilfen und sonstige Technische Dokumentation. Oft – aber nicht nur – in englischer Sprache.

Welche Texte erstellt ein Technischer Redakteur?

Klassischerweise erstellen und verfassen Technische Redakteure und Technical Writer folgende Textsorten:

• Benutzerhandbücher (User Manuals), Bedienhandbücher, Bedienungsanleitungen
• Online-Hilfen
• Texte für Benutzeroberflächen
• Screencasts (Software-Videos)
• Video-Tutorials
• Referenzhandbücher
• Schnittstellenbeschreibungen (API-Dokumentation)
• Installationsanleitungen und Montageanweisungen
• Wartungshandbücher
• Ersatzteilkataloge
• Verfahrensbeschreibungen

Im weiteren Umfeld kann ein Technischer Redakteur oder Technical Writer aber auch mit dem Erstellen anderer technischer Texte betraut sein, wie:

• Technische Fachartikel und Whitepaper
• Pressemeldungen zu technischen Themen und Produkten
• Technische Texte für Webseiten und Broschüren

Welche Aufgaben hat ein Technischer Redakteur?

Ein guter Technischer Redakteur oder Technical Writer versteht seine Aufgabe nicht nur darin, ein bestehendes Produkt zu beschreiben. Er versteht seine Rolle vielmehr als „Anwalt der Benutzer“. Er möchte den Benutzern die Arbeit mit dem Produkt so angenehm, einfach und effizient wie möglich machen und setzt sich auch gegenüber der Entwicklungsabteilung und anderen Beteiligten dafür ein.

Der Technische Redakteur oder Technical Writer ist oft einer der ersten „Anwender“ eines neuen Produkts. Er kann frühzeitig:

• mögliche Schwachstellen identifizieren und Fehler finden
• aus Kundensicht konkrete Verbesserungsvorschläge liefern
• dafür sorgen, dass Dinge einfach benannt sind, überall gleich heißen, und keine überflüssigen kryptischen Abkürzungen verwendet werden – sei es auf dem Produkt selbst, in der Beschreibung und auch an allen anderen Stellen

Hinzu kommen die üblichen alltäglichen Aufgaben eines Technischen Redakteurs und Technical Writers:

• Recherche und Interviews von Wissensträgern
• Konzeption der zu erstellenden Hilfen und Dokumente
• Gestaltung und Entwicklung von Layouts und Formatvorlagen
• Schreiben von Texten
• Erstellen von Bildern
• Erstellen von Videos
• Koordinieren von Reviews und Übersetzungen