Lesezeit: 5 Min.
Das Verfassen technischer Texte ist ein Beruf, der nur auf den ersten Blick einfach und unkompliziert erscheint. Er erfordert ausgefeilte Fähigkeiten und den Einsatz verschiedener Werkzeuge, um die richtigen Inhalte zu erstellen und Informationen zu vermitteln, die treffend und leicht verständlich sind. Die Herausforderung beim Verfassen technischer Texte beginnt mit einem tiefgreifenden Verständnis des Produkts oder der Dienstleistung, dem ständigen Auf dem Laufenden bleiben über dessen bzw. deren Funktionen sowie der Kenntnis und dem Verständnis der Zielgruppe.
Die Arbeit als technischer Redakteur kann recht mühsam sein. Dazu gehört es, alle technischen Details zusammenzutragen, dafür zu sorgen, dass der Inhalt nicht eintönig wirkt, und den Dokumentationsprozess so zu optimieren, dass keine oder nur vernachlässigbare Fehler auftreten. Gutes technisches Schreiben erfordert ein Bewusstsein für und Kenntnisse über Tools, die die Arbeit erleichtern. Bevor wir uns den gängigen Tools für das technische Schreiben zuwenden, wollen wir uns zunächst einige unverzichtbare Fähigkeiten für das technische Schreiben ansehen. Dazu gehören beispielsweise:
- Recherchekompetenzen
- Recherche und Erkundung bilden das Rückgrat der technischen Inhalte und verleihen den Daten mehr Glaubwürdigkeit und Überzeugungskraft. Als technischer Redakteur bei jedem Auftraggeber muss man über Produkte oder damit verbundene Daten schreiben, von denen man zuvor noch nie gehört hat. Gute Recherchefähigkeiten und ein scharfer Beobachtungssinn helfen dabei, Informationen aus verschiedenen Quellen zusammenzutragen und daraus Inhalte zu formulieren.
- Zielgruppenanalyse
- Eine Zielgruppenanalyse bedeutet, ein gutes Verständnis für den Endnutzer zu entwickeln und inklusive Inhalte zu erstellen. Die Analyse der Zielgruppe ist für den Erfolg jedes technischen Redakteurs von entscheidender Bedeutung. Es ist notwendig, die Leser in drei Gruppen einzuteilen: sehr technisch versierte, mäßig technisch versierte und weniger technisch versierte. Dies bildet die Grundlage für die Gestaltung der Texte; eine Zielgruppe mit weniger technischem Wissen benötigt Texte (Inhalte), die weniger technisch sind. Einige wichtige Fragen, die bei der Durchführung einer Zielgruppenanalyse helfen, sind:–
- Wer ist Ihre Zielgruppe?
- Was wissen sie über Ihr Fachgebiet?
- Was machen sie beruflich?
- Was sind ihre Interessen und Bedürfnisse?
- Kommunikationsfähigkeiten
- Die Aufgabe eines technischen Redakteurs besteht darin, aktiv zuzuhören und zu planen, bevor er sich am schriftlichen Diskurs beteiligt. Gute Kommunikationsfähigkeiten tragen wesentlich zur allgemeinen Kompetenz eines technischen Redakteurs bei. Gute Kommunikation ebnet den Weg, sei es bei der Abstimmung mit Fachexperten oder Projektbeteiligten oder beim Stellen wichtiger Fragen zur Informationsbeschaffung.
- Schreibfähigkeiten
- Präzises und prägnantes Schreiben ist eine unverzichtbare Fähigkeit für technische Redakteure. Redakteure sollten in der Lage sein, in technischen Handbüchern, Standardarbeitsanweisungen (SOPs) und technischen Berichten sowie vielen anderen Dokumentarten korrekte Informationen zu vermitteln.
- Technische Fähigkeiten
- Es besteht ein Unterschied zwischen dem Erwerb eines Diploms oder Abschlusses in einem technischen Fachgebiet und fundierten Kenntnissen in speziellen Bereichen. Letzteres ist eine unverzichtbare Voraussetzung für die Tätigkeit als Technischer Redakteur. Von Technischen Redakteuren wird erwartet, dass sie in wichtigen Branchen tätig sind, von IT, Versicherungen und Bankwesen bis hin zu Medizinprodukten, Pharmazeutika, Gesundheitswesen usw.
- Teamarbeit
- Obwohl man meist von einer Tätigkeit am Schreibtisch ausgeht, müssen technische Redakteure häufig mit funktionsübergreifenden Teams und Abteilungen zusammenarbeiten. Die Zusammenarbeit mit Designern, Entwicklern, Testern, Projektmanagern und Produktmanagern gehört zum Arbeitsalltag technischer Redakteure. Ein technischer Redakteur muss teamfähig sein und den Teamzusammenhalt fördern sowie über Fähigkeiten zur Konfliktlösung, Entscheidungsfindung sowie Planung und Organisation verfügen.
Auch wenn es sich hierbei nicht um eine vollständige Liste handelt, gehören doch einige der wichtigsten Tools dazu, über die ein Technischer Redakteur verfügen muss. Tools für das technische Schreiben und die Software-Dokumentation helfen Technischen Redakteuren dabei, die richtigen Inhalte zusammenzustellen, um kontextbezogene Informationen korrekt und leicht verständlich darzustellen. Diese Tools sind beim Verfassen, Bearbeiten, Erstellen von Zeichnungen, Überprüfen und Überarbeiten von Dokumentationen nützlich.
Auch wenn die Phasen weitgehend unverändert bleiben, variieren die Auswahl und der Einsatz der Tools in gewissem Maße je nach Produkt oder Branche. Eine programmierungsspezifische IT-Umgebung erfordert möglicherweise Tools, die Flexibilität bei der API-Dokumentation bieten. Im Gegensatz dazu konzentriert sich die Medizinproduktebranche auf Tools, die besser zugängliche Gestaltungsmöglichkeiten bieten. Angesichts der Vielfalt der verfügbaren Tools für die technische Dokumentation wollen wir uns auf diejenigen konzentrieren, die genau auf Medizinprodukte zugeschnitten sind. Dazu gehören beispielsweise:
- Microsoft Word
Microsoft Word ist ein einfaches und eher grundlegendes Tool, um ganz oben auf der Liste zu stehen. Durch die einfache Kombination von MS Word mit Adobe Acrobat Reader Pro können Sie nahtlos Dokumente erstellen und problemlos zwischen den Formaten PDF und DOC konvertieren. Tatsache ist, dass MS Word nach wie vor das am häufigsten verwendete Tool zur Erstellung verschiedener Dokumente ist und der beste Freund eines technischen Redakteurs ist. Es ist so verbreitet, dass auch dieser Artikel damit verfasst wurde!
- Windows-Bildschirmaufnahme-Tool
Das Windows-Snipping-Tool ist Teil der Windows-Software-Suite und ein hervorragendes Hilfsmittel für einfache Bildschirmaufnahmen. Neben Vollbildaufnahmen ermöglicht es das Freihand-Zuschneiden oder das Zuschneiden bestimmter Bereiche. Eine praktische Funktion dieses Tools ist die Verzögerungsoption, mit der sich Standbilder aus genau dem gewünschten Bildausschnitt eines Videos aufnehmen lassen.
- Powtoon
Technische Dokumentation und die damit verbundenen Aufgaben werden zunehmend visuell gestaltet. Powtoon ist ein hervorragendes webbasiertes Animationstool, das als SaaS-Produkt angeboten wird. Es ermöglicht die Erstellung innovativer, animierter Präsentationen und Erklärvideos. Animierte Präsentationen sind eine ansprechende Methode, um die Aufmerksamkeit der Nutzer zu gewinnen, und mit Powtoon können Sie diese Kunst meisterhaft beherrschen.
Für technische Redakteure gehört das Erstellen von Screenshots zum Arbeitsalltag, insbesondere wenn es um die Dokumentation von Software als Medizinprodukt geht. Bilder sind die beste Möglichkeit, Funktionen darzustellen und die Inhalte leicht verständlich zu machen.
SnagIT ist ein Tool zur Bildschirmaufnahme für technische Redakteure, mit dem sie ihre Dokumente einheitlich und professionell gestalten können. Es bietet unter anderem folgende Funktionen:
- Panorama-Scroll-Aufnahme
- Erfasst Dropdown-Menüs
- Rahmen und Bildeffekte
- Export in den Cloud-Speicher
Es handelt sich um ein Tool zur Erstellung technischer Dokumentationen, mit dem die meisten Menschen die Grundlagen der HTML-Programmierung erlernen. Es ist ein äußerst effektiver und benutzerfreundlicher HTML-Editor für Anfänger. Er wird hauptsächlich zur Erstellung mittelgroßer Hilfedateien verwendet, sofern ein Softwareprodukt keine umfangreiche Online-Hilfe erfordert.
Adobe Photoshop bedarf keiner Vorstellung. Es ist das weltweit beliebteste Bildbearbeitungsprogramm zum Erstellen und Bearbeiten von Fotos und artwork. Zudem ist es auch unter technischen Redakteuren ein beliebtes Werkzeug. Es erweist sich als nützlich beim Erstellen von UI-Designs, beim Bearbeiten von Bildern für den Druck, beim Manipulieren von Bildern, beim Überlagern eines Bildes mit einem anderen und vielem mehr. Ein praktisches Merkmal dieses Programms ist, dass die Bildbearbeitung ein reversibler Vorgang bleibt, sodass Änderungen problemlos rückgängig gemacht werden können.
Windows Movie Maker ist ein weiteres Tool, das standardmäßig Teil der Windows Essentials-Software-Suite ist (bis Januar 2017). Es handelt sich um ein einfaches Tool, mit dem technische Redakteure Videos bearbeiten können.
Adobe FrameMaker ist ein Autorentool für alle technischen Redakteure, die Inhalte wiederverwenden möchten, themenbasiert schreiben und einen strukturierten Dokumentationsprozess verfolgen. Es handelt sich um ein Dokumentenbearbeitungstool, das sich für umfangreiche, dem Industriestandard entsprechende Dokumentationen eignet. FrameMaker ist ein DITA-kompatibles (Document Information Typing Architecture) Tool für die technische Dokumentation mit integrierter PDF-Ausgabefunktion und eine hervorragende Alternative zu Textverarbeitungsprogrammen wie MS Word. Zu den wichtigsten Funktionen zählen:
- Bildgröße mit einem Klick anpassen
- XML Dateiverwaltung
- Veröffentlichung auf mehreren Geräten
- Mini-Inhaltsverzeichnis
oXygen XML Author ist ein kostenloser, quelloffener, DITA-konformer Editor für „ XML “. DITA ist ein offener Standard für die Erstellung und Veröffentlichung von Dokumenten, der zunehmend in der technischen Dokumentation Einzug hält. Er macht die Bearbeitung von Inhalten unabhängig von einem bestimmten Tool. Außerdem ermöglicht er die Erstellung von DITA-konformer Online-Dokumentation (eine Sammlung von „ XML “-Dateien) und eröffnet damit die Möglichkeit, die Dateien in Zukunft mit jedem anderen DITA-konformen Tool einfach zu bearbeiten, zu aktualisieren und zu pflegen.
Abgesehen von der oben aufgeführten Liste bekannter Tools sind einige weitere Programme wie Microsoft PowerPoint, Microsoft Excel (für Anfänger), Prezi, Help+Manual und HelpnDoc unverzichtbar, wenn man mit dem Verfassen technischer Dokumentationen für Medizinprodukte beginnt.
Wenden Sie sich an einen Experten für technische Dokumentation, um weitere Einblicke in die technische Dokumentation von Medizinprodukten zu erhalten.
