Mein Berufsfeld als Technischer Redakteur ist interdisziplinär. Nicht nur technische Fragen beschäftigen mich, sondern auch gesetzliche, normative, sprachliche und didaktische. Darüber hinaus ist oft Spezialwissen zu Werkzeugen, Informationsmodellen und Publikationsprozessen gefragt. Diese vielschichtigen Aufgaben bringen mich in Kontakt mit unterschiedlichen Experten, mit denen ich zusammenarbeite.

  • Technikexperten wie Entwickler, Programmierer und Ingenieure liefern mir technische Informationen und prüfen später mein Korrekturmanuskript.
  • Experten für Sprache pflegen Terminologie, übersetzen und lokalisieren.
  • Experten für Produktsicherheit, Normung und Compliance pflegen z. B. Betriebsnormen und erstellen Risikobeurteilungen, die ich benötige.
  • Andere Technische Redakteure oder Information Manager dokumentieren entweder andere Produkte oder übernehmen spezielle Aufgaben im Redaktionszyklus.
  • Auf die Zusammenarbeit mit weiteren Experten wie z. B. Druckern, IT-Personal oder Personen aus dem Projekt-Management gehe ich nicht ein, weil sie kein Kernthema der Technischen Redaktion ist.

Mit jedem dieser Spezialisten rede ich – und mit jedem anders. Dieser Blog-Artikel beschreibt, wie ich mir als Technischer Redakteur die jeweilige Zusammenarbeit mit diesen Spezialisten wünsche, sodass ein effizienter Dialog entsteht.

Zusammenarbeit mit Technikexperten

Wussten Sie, dass der Erstellungsprozess von technischen Dokumenten dem Übersetzungsprozess in andere Sprachen ähnelt? Technische Redakteure übersetzen Informationen von Technikexperten in Dokumente für Anwender. Man kann sagen, Technikexperten und Technische Redakteure sprechen unterschiedliche Sprachen. Technikexperten liefern Produkt-Informationen: Wie ist das Produkt aufgebaut und wie funktioniert es? Technische Redakteure übersetzen die Produkt-Informationen in Tätigkeits-Informationen: Wer macht wann was mit dem Produkt?

Damit die richtigen Informationen bei mir ankommen und korrekt in die technischen Dokumente übersetzt werden können, hat sich aus meiner Erfahrung folgende Vorgehensweise bewährt.

  1. Vertrauen Sie mir als Technischem Redakteur, wie ich Ihnen als Technikexperte vertraue und überlassen Sie mir die Initiative. Sie können ganz entspannt mit dieser Frage starten: „Was brauchen Sie von mir?“
  2. Es ist wichtig, dass ich in einem Interview Fragen stellen kann – idealerweise direkt am Produkt. Gehen Sie nicht automatisch davon aus, dass die Übergabe bestimmter Dokumente dieses Interview vollständig ersetzen kann.
  3. Wenn ein fester Rechercheprozess vereinbart werden soll, z. B. Formulare, Checklisten oder Ordner zur Ablage bestimmter Dokumente, lassen Sie mich daran mitwirken. So etablieren wir einen effizienten Prozess.
  4. Ermöglichen Sie mir die Recherche am Produkt, z. B. an einem Prototyp. Es ist beinahe unmöglich, korrekte und benutzerfreundliche technische Dokumente zu erstellen, ohne am Produkt recherchiert zu haben.
  5. Ermöglichen Sie mir die Recherche bei Verwendern des Produkts, z. B. bei Servicetechnikern oder Testern, die die Endabnahme durchführen. So bekomme ich praxisnahe Informationen.
  6. Informieren Sie mich, sobald sich etwas konstruktiv ändert. Ansonsten geraten vereinbarte Termine in Gefahr.

Damit ein rechts- und normenkonformes technisches Dokument entstehen kann, benötige ich wieder Ihr Vertrauen.

  1. Überlassen Sie mir die Entscheidung darüber, was in die technischen Dokumente gehört und was nicht, wo es dort steht und wie es formuliert, strukturiert und gestaltet wird. So erzielen wir gemeinsam rechts- und normenkonforme Dokumente und vermeiden Überflüssiges.

Nach der Erstellung lege ich Ihnen ein Korrekturmanuskript zur Prüfung vor. Das ist normativ vorgeschrieben. Zusätzlich bekommen Sie von mir eine kurze Info, was genau Sie prüfen sollen, z. B. welchen Abschnitt oder welche Informationen. Damit diese Prüfung effizient abläuft, gehen Sie am besten wie folgt vor.

  1. Ich benötige Ihre Expertise als Technikexperte. Prüfen Sie das Korrekturmanuskript daher aufmerksam: Sind die technischen Informationen korrekt und vollständig?
  2. Wenn etwas nicht stimmt: Liefern Sie mir echte Korrekturen, keine Kommentare. Kommentieren Sie nicht „falsch“, sondern beschaffen Sie die korrekte Information und schreiben Sie diese in das Korrekturmanuskript. Damit werden wir ein unschlagbares Team und beschleunigen den Prozess enorm.
  3. Machen Sie Korrekturen an der Stelle, auf die sie sich beziehen. So verhindern Sie, dass ich nachfragen muss.
  4. Stellen Sie sicher, dass alle Technikexperten im selben Korrekturmanuskript korrigieren. So verhindern Sie, dass ich doppelte oder widersprüchliche Korrekturen erhalte. Außerdem reduzieren Sie dadurch Ihren eigenen Aufwand.
  5. Vermeiden Sie möglichst Kommentare zu Stil, Terminologie und Layout, z. B. wie etwas formuliert, strukturiert oder gelayoutet ist. Dafür gibt es feste Vorgaben, die ich befolgen muss. Vor allem, wenn die Technische Redaktion mit einem Redaktionssystem arbeitet, kann sich das Layout außerdem je nach Publikation deutlich unterscheiden (z. B. online vs. print).
  6. Schreiben Sie keine Rückfragen in das Korrekturmanuskript, die ich nicht beantworten kann. Klären Sie solche Fragen lieber außerhalb des Korrekturlaufs mit den zuständigen Ansprechpartnern.
  7. Wenn ich im Korrekturmanuskript Fragen an Sie als Technikexperten stelle, beantworten Sie diese bitte auch dann, wenn Ihnen der Hintergrund der Frage nicht unmittelbar klar ist. Es ist unsere letzte Chance, offene Punkte zu klären.
  8. Nutzen Sie das vorgesehene Medium für den Korrekturlauf. Wenn Sie eine PDF-Datei von mir bekommen, nutzen Sie die PDF-Kommentarfunktion. Wenn Sie stattdessen einen Link zu einer Vorschau in einem Redaktionssystem bekommen, nutzen Sie die dort verfügbare Online-Kommentarfunktion. Wenn Sie dort einen Korrektur-Typ angeben können (z. B. „Änderungsvorschlag“, „fehlende Information“, „löschen“ usw.), tun Sie das bitte. So unterstützen Sie einen effizienten Korrekturlauf.
  9. Wenn irgendetwas unklar ist, z. B. was Sie wie prüfen sollen oder welche Korrekturwerkzeuge wie eingesetzt werden sollen, fragen Sie gerne jederzeit nach. Diser Prozess kann an Ihre Anforderungen angepasst werden.

Diese Vorgehensweisen sparen Technikexperten Zeit. Sie müssen keine Informationen bereitstellen, die später nicht benötigt werden. Sie müssen den Prozess nicht steuern, weil Technische Redakteure ihn von sich aus voranbringen. Technische Redakteure übernehmen dabei oft einen ersten internen Korrekturlauf und tragen so zur Produktqualität bei.

Zusammenarbeit mit Experten für Sprache

Terminologen arbeiten mit mir zusammen an einer einheitlichen, verständlichen und professionellen Unternehmenssprache. Übersetzer arbeiten mit mir zusammen, damit die meist auf Deutsch erstellten technischen Dokumente auch von Personen mit anderer Muttersprache genutzt werden können. Die jeweilige Zusammenarbeit bleibt meist unbemerkt von anderen und verläuft problemlos, wenn Folgendes sichergestellt ist.

  1. Übersetzer sollen jederzeit direkt mit mir sprechen können, um offene Fragen zu klären. Das verursacht kaum Aufwand, verbessert aber nachweislich die Übersetzungsqualität und mindert das Produkthaftungsrisiko in Fremdsprachen.

Terminologen sollen jederzeit bei mir recherchieren können und umgekehrt.

Zusammenarbeit mit Produktsicherheitsexperten

Von vielen Produkten gehen Gefährdungen für Personen oder Sachwerte aus, die konstruktiv nicht vermieden werden können. Eine der wichtigsten Aufgaben Technischer Dokumentation ist es daher, Schäden zu verhindern, indem sie vor diesen Gefährdungen warnt. Dies ist einer der am stärksten reglementierten und strukturierten Prozesse der Technischen Redaktion überhaupt. Er funktioniert optimal, wenn Folgendes sichergestellt wird.

  1. Legen Sie mir Risikobeurteilungen und weitere sicherheitsrelevante Dokumente rechtzeitig, vollständig und aktuell vor.

Wenn sich an den Dokumenten etwas ändert, geben Sie mir bitte baldmöglichst Bescheid, was sich geändert hat. So halten wir die vereinbarten Termine ein.

Zusammenarbeit mit anderen Technischen Redakteuren

Typischerweise benötige ich Unterstützung durch andere Technische Redakteure. Der wichtigste Grund dafür ist der normativ vorgeschriebene Informationsmanagement-Prozess. Eine zweite Person – ggf. unterstützt durch eine KI oder einen Schematron-Report – prüft nach dem Vier-Augen-Prinzip, ob die Regeln des Redaktionsleitfadens korrekt eingehalten wurden und ob Terminologie und Rechtschreibung stimmen.

Diese Zusammenarbeit findet ebenfalls oft unbemerkt von anderen statt. Sie funktioniert am besten, wenn sie nicht behindert wird, z. B. durch zu kurze Abgabefristen. Sie sorgt für rechts- und normenkonforme sowie benutzerfreundliche technische Dokumente – und trägt so zum Ansehen und Erfolg Ihres Unternehmens bei.

Fazit

Gute Technische Dokumentation entsteht in Dialogen zwischen Technischer Redaktion, Entwicklung, Produktsicherheit, Übersetzung und weiteren Fachbereichen. Die Initiatoren und Gestalter dieser Dialoge sollen oft die Technischen Redakteure sein. So erzielen wir gemeinsam effiziente, rechts- und normenkonforme und vor allem benutzerfreundliche Informationen, die einen echten Mehrwert darstellen.