Was macht eine Technische Redaktion und worauf kommt es beim Erstellen Technischer Dokumentation an?

Wer arbeitet in der Technischen Redaktion?

In einer Technischen Redaktion arbeiten Technische Redakteure. Redakteure an sich kennt man vielleicht auch von Zeitungen, Journalen, dem Fernsehen, etc. Ein Redakteur kümmert sich in der Regel darum, ein Thema von vielen Seiten zu beleuchten und dem Leser zugänglich zu machen. Technische Redakteure kümmern sich konkret darum, dass das Produkt im Mittelpunkt steht und geeignet in Szene gesetzt wird.

Technische Redakteure haben ein gewisses Technik-Verständnis, sind häufig als Quereinsteiger aus anderen Berufen oder Abteilungen zu dieser Arbeit gekommen - und haben einen Faible dafür, Sachen kurz und prägnant darzustellen (ob in Worten, grafisch oder multimedial sei dahingestellt). Außerdem sind sie stilsicher, kommunizieren aber vielleicht etwas langweilig, denn sie wissen, welchen Wert Terminologie hat.

Wenn Sie Ihre Redaktion zeitweise unterstützen lassen wollen, sind Sie bei den erfahrenen Technischen Redakteuren der Handbuch Experten goldrichtig. Flexibel, schnell und effizient unterstützen wir Ihre Redaktion mit unserem Vor-Ort Service.

Was wird in der Technischen Redaktion gemacht?

In der Technischen Redaktion wird Technische Dokumentation erstellt. Das kann zum einen bedeuten, dass die Benutzerinformation oder Betriebsanleitung erstellt wird. Das kann aber noch viel weiter gehen. In einer Technischen Redaktion wird viel geschrieben und damit nachweislich dokumentiert.

Idealerweise wird die Technische Redaktion bei der Produktentstehung eingebunden und dokumentiert vielleicht auch hier schon wichtige Punkte, die zur internen Dokumentation gehören. Alternativ müssen die Technischen Redakteure wie ein Detektiv die notwendigen Informationen in der Produktentwicklung und -konstruktion zusammensuchen.

Das bedeutet, in der Technischen Redaktion wird ein Konzept erstellt oder umgesetzt, die Technische Dokumentation anhand eines Redaktionshandbuchs systematisch erstellt oder aktualisiert. Die Dokumentation umfasst dabei zum Beispiel die Installations- und Montageanleitung, Bedienungsanleitung, Schulungsunterlagen, Online-Hilfen und vielleicht auch Produktkataloge. Das kann in einer Sprache sein, oder auch für weitere Zielländer die Übersetzung oder das Handling der Übersetzung mit entsprechenden Dienstleistern bedeuten.

Welche Schnittstellen gibt es mit der Technischen Redaktion?

Je nach Aufgabenfeld des Redakteurs kann es eine sehr schmale und eng definierte Schnittstelle zur Produktentwicklung geben - oder auch viele verschiedene Abteilungen betreffen.

Wenn die Technische Redaktion damit betraut ist, alle Produkt-relevanten Informationen zusammenzutragen und im Unternehmen und auch der Außenwelt verfügbar zu machen, kann das eine Zusammenarbeit mit folgenden Abteilungen betreffen:

• Marketing und Vertrieb
• Entwicklung und Konstruktion
• Service und Schulungspersonal
• Wartungspersonal sowie Produktnutzer
• Rechtsabteilung oder Compliance-Verantwortliche

Braucht es Projektmanagement in der Technischen Redaktion?

Da es viele Schnittstellen gibt und häufig die Betriebsanleitung am Ende der Produktentwicklung erst richtig zum Tragen kommt, ist Projektmanagement in der Technischen Redaktion unerlässlich. Häufig arbeiten Technische Redakteure autark und sind innerhalb ihrer eigenen Projekte nicht nur für die Sammlung der Informationen, die Aufbereitung des Inhalts und viele weitere Punkte zuständig. Sondern müssen ihr Projekt selbst managen und sich darum kümmern, dass die Dokumente zum gewünschten Zeitpunkt erstellt sind. Wie das im Detail abläuft, ist häufig dem Redakteur selbst überlassen.

Einige Tipps für das Projektmanagement in der Technischen Redaktion möchten wir an dieser Stelle mit Ihnen teilen:

1. Kennen Sie den Fertigstellungstermin und planen Sie Ihre Arbeit so, dass dieser eingehalten werden kann. Idealerweise mit einigen Puffern, denn in der Produktentwicklung läuft häufig mal etwas nicht exakt nach Plan und darauf muss die Technische Redaktion flexibel reagieren können.
2. Kennen Sie alle Ansprechpartner die in das Projekt involviert sind und deren Schwerpunkte, um an die gewünschten Informationen zu kommen. Versuchen Sie, die Informationen systematisch abzufragen, damit die Kommunikation möglichst gering und reibungslos ausfallen kann.
3. Kennen Sie das Tool, in dem Sie die Technische Dokumentation erstellen sollen, sowie die Ablageorte für diverse Daten, die Ihnen ebenfalls als Informationsquelle dienen können.
4. Wenn es ein Dokumentations-Konzept oder einen Redaktionsleitfaden gibt, sollten Sie diese Informationen ebenfalls vor Erstellungsbeginn kennen und beherzigen.
5. Bei der Erstellung der Benutzerinformation: achten Sie auf einheitliche, gehirngerechte und an die Zielgruppe angepasste Informationen; verwenden Sie einheitliche Begriffe, berücksichtigen Sie falls vorhanden die Terminologie-Liste.
6. Eskalieren Sie rechtzeitig, wenn der Zeitplan nicht eingehalten werden kann. Gehen Sie dabei möglichst behutsam mit Ihren Informationslieferanten um, denn Sie sind von guter Zusammenarbeit ein Stück weit abhängig.
7. Arbeiten Sie nach dem 4-Augen-Prinzip:
   1. lassen Sie einen Kollegen / eine Kollegin aus der Technischen Redaktion prüfen, ob Ihre Informationen so ankommen, wie sie sollen und ob Rechtschreibung und Orthographie passen und
   2. lassen Sie jemanden aus der Produktentwicklung prüfen, ob die Informationen fachlich korrekt sind.
8. Erstellen Sie die gewünschten Ausgabeformate innerhalb Ihres Zeitrahmens.
9. Prüfen Sie rückwirkend, was gut oder schlecht gelaufen ist und überlegen Sie, wie Sie gutes noch besser und schlechtes optimieren können und setzen Sie das beim nächsten Projekt um.

Es ist also unerlässlich, ein gewisses Projektmanagement in der Technischen Redaktion umzusetzen, auch wenn es häufig "nebenbei" gehen muss, da meist nicht nur ein kleines, überschaubares Projekt auf Redakteuren lastet. Wichtig ist, auch hier mit Maß zum Ziel zu gelangen und das Hauptaugenmerk auf die Projektarbeit und nicht das Projektmanagement zu richten.

Wozu ist eine Technische Redaktion hilfreich?

Das Wissen, das zum Produkt gesammelt wird, ist nur dann hilfreich, wenn es auch zugänglich gemacht wird. Die Redaktion kann helfen, das Wissen an einer zentralen Stelle zu sammeln, zu organisieren und langfristig auffindbar und damit für alle verfügbar zu machen.

Außerdem verstehen sich Technische Redakteure besonders darauf, Wissenslücken zu identifizieren und diese zu schließen. Das heißt, wenn Unterlagen fehlen, können Redakteure sich darum kümmern, diese anzufordern oder bei der Erstellung zu helfen.

Was sollten Technische Redakteure können?

Das wichtigste für einen Redakteur ist, das Wissen zum Produkt und dessen sichere und effiziente Nutzung zu sammeln und das geeignet aufbereitet zu dokumentieren.

Hilfreich dazu ist zusätzlich der Umgang mit den Tools, in denen dokumentiert werden soll.

Ein Verständnis zu Normen, gesetzlichen Vorgaben, etc. ist ebenfalls von Vorteil, besonders die Teile, die sich mit den zu dokumentierenden Informationen befassen.

Zudem sind gute Kommunikationsfähigkeiten notwendig, um den Informationsfluss mit den anderen Abteilungen zu gewährleisten.

Wovon sollten Technische Redakteure besser die Finger lassen?

Immer wieder hören wir von Kollegen in der Technischen Redaktion, dass ihr Unternehmen sie mit deutlich mehr Aufgaben betraut, als das reine Erstellen von Benutzerinformationen. Das kann, je nach Ausbildung und Hintergrundwissen des Redakteurs gut funktionieren - oder eben auch nicht.

Wenn ein Redakteur z. B. erzählt, er muss die Risikobeurteilung für die Produkte seines Unternehmens erstellen, kann das durchaus für große Augen sorgen. In der Praxis sind aber viele Möglichkeiten bei der Gestaltung dieser Tätigkeit denkbar. Sollte der Redakteur, der systematisch Informationen aufbereiten kann und des Schreibens mächtig ist, den Entwicklern und Konstrukteuren "zur Hand gehen" bzw. zum Stift greifen und die Informationen aufnehmen und dokumentieren, ist das sicherlich eine gute Lösung. Oder wenn ein ehemaliger Konstrukteur in die Redaktion wechselt und diese Aufgaben für seine Kollegen übernimmt, kann er sicherlich auch einzelne Projekte komplett autark darstellen. Sollte jedoch ein Redakteur ohne Kenntnisse der Produktentwicklung dazu genötigt werden, ist das weder für den Redakteur noch für das Unternehmen ein Gewinn.

Die Aufgaben sollten also einerseits zwingend mit dem vorhandenen Wissen und dem Hintergrund des Redakteurs verteilt werden, andererseits können Redakteure, die deutlich seltener an Schreibblockaden leiden, Entwickler und Konstrukteure etc. entlasten indem Sie deren Produktwissen geeignet schriftlich festhalten und darstellen.