5 wesentliche Qualifikationen, die Sie brauchen, um ein hervorragender technischer Redakteur zu werden

Essential skills for every technical writer

Was ist der Unterschied zwischen einem hervorragenden technischen Redakteur und einem hervorragenden Schriftsteller?
Beide sind hervorragende Autoren. Aber nur einer von beiden beherrscht die Schlüsselqualifikationen, die erforderlich sind, um nahezu jedem unabhängig von seinem oder ihrem technischen Know-how die Benutzung nahezu jedes Produkts, das technische Kenntnisse voraussetzt, verständlich zu machen.
Wenn Sie ein technischer Redakteur sind oder vielleicht Interesse an diesem Beruf haben, dann ist es auch für Sie wichtig, die erforderlichen Qualifikationen zu beherrschen. Um Ihnen das technische Schreiben zu vereinfachen, haben wir 5 der wichtigsten Qualifikationen zusammengestellt, die jeder professionelle technische Redakteur beherrschen sollte.

Die 5 Qualifikationen, die Sie als professioneller technischer Redakteur beherrschen sollten

1. Beherrschen Sie die Durchführung von Usability-Tests

Das Vermitteln von impliziertem Wissen über das Design oder die Funktionen eines Produkts gehört zu den zentralen Aufgaben eines technischen Redakteurs. Eine der einfachsten Methoden hierzu beinhaltet das Beschreiben leicht verständlicher Szenarien, denen die Produktbenutzer während der Benutzung des Produkts begegnen können.
Aus diesem Grund bitten viele Hersteller und Software-Entwickler ihre technischen Redakteure darum, ihre Produkte vor dem Schreiben von Handbüchern und anderen Dokumentationen zu benutzen und zu testen. Mitunter werden Sie gebeten, zusammen mit dem User-Experience-Team zu überprüfen, ob das Produkt tatsächlich so funktioniert, wie es dem Design nach funktionieren sollte.
Um diese Qualifikation zu beherrschen, müssen Sie die einzelnen Funktionen und Unterfunktionen des Produkts nacheinander testen. Erstellen Sie eine Liste der Funktionen, die sachgemäß funktionieren, und eine separate Liste derjenigen Funktionen, die schlecht funktionieren. Mitunter kann es sein, dass alle Funktionen sachgemäß funktionieren, die Benutzerschnittstelle oder das Design jedoch schlecht sind. Zögern Sie nicht, dies als ein wesentliches Problem aufzulisten.

2. Beherrschen Sie die Anwendung von Hilfe-Entwicklungstools

Jeder technische Redakteur sollte mindestens ein Hilfe-Entwicklungstool kompetent anwenden können. Hilfe-Entwicklungstools sind dazu konzipiert, den Prozess des technischen Schreibens und das Veröffentlichen von Dokumentationen in verschiedenen Formaten zu vereinfachen. Einige dieser Tools wie beispielsweise HelpNDoc sind für den persönlichen Gebrauch kostenlos und können verschiedene Content-Formate, einschließlich HTML, CHM-Hilfedateien, PDF, Word, Qt Help-Dateien, iPhone-Websites, ePubs- und Kindle-E-Books, erstellen.

Es gibt viele Optionen für das Veröffentlichen von Dokumentationen, und man sollte bei der Auswahl des richtigen Formats und vor allem bei der Entscheidung zwischen einem gedruckten Handbuch oder einem Bildschirm-Handbuch die angestrebte Leserschaft berücksichtigen.

3. Beherrschen Sie die Durchführung von Recherchen

Recherchen sind die Grundlage jeder guten technischen Dokumentation. Und wenn das Fundament schwach ist, wird die Dokumentation in einem Papierkorb landen und dem Produkthersteller zusätzliche Kosten für die Kundenbetreuung verursachen. Aus diesem Grund kann das Schreiben eines hochwertigen Handbuchs die beste Investition eines Entwicklers oder Herstellers sein.
In vielen Fällen ist die Qualität der Dokumentation niemals besser als die Qualität der Recherche. Das adäquate Recherchieren jeder Facette Ihres Themas ist also ausschlaggebend für das Schreiben einer guten Dokumentation. Vielen Lesern und Produktbenutzern fallen vage und irrelevante Inhalte schnell auf. Ohne eine angemessene Recherche ist es wahrscheinlich, dass Ihnen die größten Fehler, die etliche Autoren von Handbüchern machen, passieren.

4. Beherrschen Sie die Befragung von Fachexperten (SME)

Wenn Sie ein neues technisches Schreibprojekt beginnen, sollten sie alle verfügbaren Informationen zusammentragen, und der Hersteller wird versuchen, sie Ihnen zu geben, sie eventuell jedoch nicht immer erfolgreich mitteilen. An einem gewissen Punkt werden Sie also Fragen stellen müssen, um den Subject-Matter-Experten (SME) die relevanten Informationen, die Sie brauchen, zu entlocken.
Die Durchführung einer Befragung ist eine der besten Methoden zum Stellen dieser Fragen. Wenn Sie das Befragen von SME noch nicht beherrschen, kann die Durchführung einer Befragung mit dem Ziel, alle wichtigen Informationen zu eruieren, jedoch wie eine große Herausforderung erscheinen.
Es gibt 3 wesentliche Phasen der Befragung von SME. Zunächst müssen Sie die Befragung vorbereiten, dann müssen Sie die Befragung durchführen, und anschließend müssen Sie die wesentlichen Punkte, die für Ihre Dokumentationen relevant sind, extrahieren.

So bereiten Sie die Befragung vor

Als erstes müssen Sie einige Hintergrundrecherchen zum Thema oder zu der Dokumentation, die Sie schreiben wollen, durchführen. Dann müssen Sie die früheren Arbeiten Ihrer SME, die im Zusammenhang mit Ihrem aktuellen Projekt stehen, recherchieren. So werden Sie eine klare Vorstellung davon bekommen, wie Sie diese Experten am besten ansprechen und Ihre Fragen so formulieren können, dass Sie die wesentlichen Punkte, die Sie benötigen, extrahieren.
Im nächste Schritt bereiten Sie Ihre Fragen vor. Beginnen Sie mit den Informationen, die Sie während Ihrer Recherche zusammengetragen haben. Diese Methode wird es Ihnen einfacher machen, eine logische Gliederung für alle Ihre Fragen zu erstellen. Sie können erwägen, Ihre Fragen nach der Art von Journalisten zu stellen. Journalisten beginnen oft mit den 5 Ws (wer, was, wo, wann, wie und warum). Wenn Sie Ihre Fragen festgelegt haben, setzen Sie die Befragung an und einigen Sie sich auf eine Zeit, die der befragten Person und Ihnen gut passt.

So führen Sie die Befragung durch

Lassen Sie die befragte Person nicht warten. Beginnen Sie zur geplanten Zeit und halten Sie sich an den zeitlichen Rahmen. Beginnen Sie mit einfachen Fragen, die der befragten Person helfen, sich zu entspannen. Stellen Sie sicher, dass Ihre Aufnahmesoftware oder Ihr Aufnahmegerät betriebsbereit ist, wenn Sie die Befragung auf Skype oder Google Hangout durchführen. Mitunter müssen Sie die Befragung wiederholen, um alle wichtigen Informationen, die Sie benötigen, zu extrahieren. Konzentrieren Sie sich auf das Thema, während Sie die Befragung durchführen, und vermeiden Sie Ablenkungen.

So extrahieren Sie die wichtigsten Punkte

Wenn Sie im Anschluss an die Befragung zurück an Ihrem Schreibtisch sind, sollten Sie es in Erwägung ziehen, sich das aufgezeichnete Gespräch erneut anzuhören. Listen Sie die wichtigsten Punkte auf oder fassen Sie sie zusammen. Analysieren Sie die Informationen, die Sie extrahiert haben, sorgfältig und überprüfen Sie, ob Sie nun alle Informationen haben, die Sie für das Schreiben Ihrer Dokumentation benötigen. Wenn die Informationen nicht ausreichen, müssen Sie eventuell mehrere SME oder auch andere technische Redakteure befragen, um die richtigen Antworten zu bekommen.

5. Beherrschen Sie die Kunst des übersichtlichen und präzisen Schreibens

Jeder technische Redakteur muss in der Lage sein, komplexe Ideen, Situationen und Szenarien auf eine einfache, präzise, eindeutige und prägnante Weise mitzuteilen. Beim technischen Schreiben gibt es keinen Ersatz für übersichtlichkeit, vor allem, wenn Sie ein hervorragendes Handbuch schreiben wollen. Davon abgesehen dürfen Sie das Wissen und die Erfahrung Ihres Zielpublikums nicht unterschätzen.
Wenn die Qualität Ihrer Inhalte schlecht ist, wird Ihr Zielpublikum das schnell feststellen. Wenn Sie zu viele technische Begriffe und Jargons verwenden, droht Ihre Dokumentation im Papierkorb zu landen. Passen Sie Ihre Inhalte immer an die Erwartungen und den durchschnittlichen Kenntnisstand Ihres Zielpublikums an.

Fazit

Das Wachstum des Internets in den letzten zwei Jahrzehnten hat zur Entstehung von vielen Unternehmen im Bereich der Technologie und Technik geführt. Das Ergebnis? Technische Redakteure müssen ihre Kenntnisse und Qualifikationen bezüglich neuer Softwares, Designs, Tools, Plattformen usw. ständig auf dem Laufenden halten. Mehr denn je müssen technische Redakteure heute neue Qualifikationen erlernen und beherrschen, um der Konkurrenz immer eine Nasenlänge voraus zu sein. Die in diesem Artikel erwähnten Qualifikationen gehören unabhängig vom Arbeitsgebiet zu den wichtigsten Qualifikationen von technischen Redakteuren.