Technisches Schreiben vermittelt den Lesern technische Informationen über eine Fertigkeit oder ein Produkt. Es wird häufig in technischen und beruflichen Bereichen verwendet. Als technischer Redakteur schreiben Sie häufig Dokumente wie Benutzerhandbücher, API-Dokumentation (Application Programming Interface) sowie Reparatur- und Produkthandbücher.
Wie andere Schreibnischen hat auch das Technische Schreiben nischenspezifische Richtlinien. Wenn Sie diese Richtlinien befolgen, können Sie gut strukturierte Dokumente schreiben und optimieren, wie Leser Ihre Arbeit verstehen. Hier sind einige Regeln, die Sie befolgen sollten, um ein guter Technischer Redakteur zu werden.
1. Definieren Sie Ihr Publikum
Die Zielgruppenanalyse ist ein unverzichtbarer Faktor in einem guten technischen Dokument. Wenn Sie Ihr Publikum kennen, können Sie bestimmen, über welche Art von Informationen Sie schreiben, wie Sie sie strukturieren sollten und wie technisch Ihre Sprache ist. Es gibt vier Hauptzielgruppen für technisches Schreiben: Führungskräfte, Experten, Techniker und Laien.
Führungskräfte sind Personen, die das Produkt finanzieren und die politischen, administrativen und wirtschaftlichen Entscheidungen treffen, die es regeln. Techniker sind die Personen, die diese Produkte bauen, bedienen und reparieren. Experten entwerfen, testen und wissen alles über das Produkt, während Laien die Endbenutzer der Produkte sind. Sie müssen Ihr Publikum berücksichtigen, um den besten Ton und Schreibstil zu bestimmen.
2. Identifizieren Sie die Bedürfnisse Ihrer Zielgruppe
Abgesehen davon, dass Sie Ihre Zielgruppe kennen und definieren, ist es entscheidend, dass Sie ihre Ziele, Interessen und Bedürfnisse verstehen. Das Abschließen Ihrer Zielgruppenanalyse ist der Schlüssel zur Vorbereitung von Dokumenten, da Sie wahrscheinlich nicht ohne Schluckauf schreiben und die Bedürfnisse Ihrer Zielgruppe gut kennen.
Um eine abgerundete Publikumsanalyse durchzuführen, müssen Sie den Hintergrund und das vorhandene Wissen Ihres Publikums berücksichtigen das Produkt, Erfahrung, Bedürfnisse, Interessen, demografische Merkmale, Kultur- und Kommunikationspräferenzen und Ziele. Diese Informationen helfen Ihnen, Ihre Ideen am effektivsten und effizientesten zu präsentieren.
3. Kennen Sie die Grenzen des Wissens Ihres Publikums
Als Publikumsanalysetechnik können Sie Umfragen und Fragebögen verwenden, um die Grenzen des Wissens Ihres Publikums zu ermitteln. Sie können auch beliebte Meinungen und Stereotype, persönliche Erfahrungen, Brainstorming und Publikumsfeedback von der Marketingabteilung einholen.
Wenn Sie die oben aufgeführten Tools richtig einsetzen, wissen Sie, wie gut Ihre Zielgruppe die Informationen versteht, die Sie vermitteln möchten. Diese Informationen bestimmen maßgeblich die Struktur, die Grenzen und den Umfang Ihres Dokuments und geben Ihnen eine Orientierung.
4. Halten Sie Ihre Sprache einfach
Technische Redaktion soll ein zu kompliziertes Thema darstellen. Dies geschieht durch die Verwendung eines einfachen Schreibstil-Leitfadens. Sie sollten sicherstellen, dass der durchschnittliche Leser Ihren Text leicht verstehen kann.
Sie müssen jedoch beachten, dass das Verständnis Ihres Publikums auch der Schlüssel für den von Ihnen gewählten Sprachstil ist. Zum Beispiel Fachjargon in einem Dokument über Anwendungsprogrammierschnittstellen (API) kann für Techniker, aber nicht für Endbenutzer geeignet sein. Folglich müssen Sie eine leicht verständliche Sprache verwenden, um das Verständnis des Publikums zu unterstützen. Vielleicht möchten Sie auch lernen wie man ein Tool wie Microsoft Editor verwendet um Ihre Arbeit zu überprüfen und sicherzustellen, dass das Schreiben auf dem Punkt ist.
5. Verwenden Sie Konturen
Gliederungen geben Ihren Lesern eine Vorstellung davon, was sie in dem Dokument erwartet. Ein Dokument ohne Gliederung überfordert den Leser, da es ihn dazu zwingt, den gesamten Text zu lesen, wenn er nur daran interessiert ist, bestimmtes Wissen zu erwerben.
Als Technischer Redakteur gibt Ihnen die Gliederung Ihres Dokuments auch eine Orientierung beim Schreiben. Es hält Sie auf dem Laufenden und stellt sicher, dass Sie keine relevanten Punkte verpassen oder unterschätzen. Darüber hinaus verbessert es die Struktur Ihres Dokuments und dient als Feedback zu dem, was Sie behandeln möchten.
6. Verwenden Sie bei Bedarf Grafiken
Die Aufmerksamkeit der meisten Leser wird naturgemäß von Grafiken im Vergleich zu Texten angezogen. In technischen Dokumenten können geeignete Grafiken das Textverständnis der Leser verbessern, indem sie Informationen klar und eindringlich darstellen.
Als Technischer Redakteur sollten Sie jedoch darauf achten, Grafiken nicht zur Dekoration von Dokumenten zu verwenden. Tabellen, Grafiken, Diagramme, Fotografien und Illustrationen sind häufig verwendete Grafiken, die die Gesamtstruktur des Dokuments verbessern und den Leser ansprechen können. Das heißt, wenn Sie neu bei Google Docs sind, hier ist wie man Tabellen in Google Docs erstellt und bearbeitet.
7. Binden Sie Ihre Leser ein
Während Sie vielleicht versuchen, Ihren Lesern technische Informationen zu vermitteln, ist es wichtig, dass Sie sie auch einbeziehen. Jedes technische Dokument ist leserzentriert und sollte nach dem Geschmack des Lesers und nicht des Autors geschrieben werden. Die intellektuelle Neugier Ihres Lesers muss befriedigt werden, damit Ihr Dokument nützlich ist.
Sie können Ihren Leser aktiv einbeziehen, indem Sie schreiben, um etwas auszudrücken, nicht zu beeindrucken, und direkt auf den Punkt kommen. Vermeiden Sie Abkürzungen und Jargon, verwenden Sie viel Leerraum, um die visuelle Präsentation zu verbessern, und verwenden Sie Überschriften, um Ihren Leser zu führen.
8. Verweisen Sie nicht auf zeitkritische Informationen
Es ist immer vorzuziehen, Verweise auf zeitkritische Informationen zu vermeiden, insbesondere solche aus einem vergleichbaren Zeitraum. Es ist sicherer und klüger, Analysen zu verwenden, die den Test der Zeit überstanden haben, was sie immergrün und immer geeignet für diejenigen macht, die Ihr Dokument in Zukunft lesen werden.
Sie müssen auch beachten, dass das Anhängen bestimmter Jahreszahlen wie „2019“, um Ihren Standpunkt hervorzuheben, die Nützlichkeit Ihres Dokuments im Laufe der Zeit verringern kann, außer in bestimmten Fällen. Sie können dies verhindern, indem Sie einen breiteren Zeitrahmen wie „In den letzten sieben Jahren“ verwenden und Ihrer Arbeit so ein gewisses Maß an Glaubwürdigkeit verleihen.
9. Verwenden Sie relevante Beispiele
Verwenden Sie beim Schreiben eines technischen Dokuments Live-Instanzen, um Ihre Punkte hervorzuheben. Da Ihre Zuhörer Ihre Texte lesen, um sich eine Fertigkeit anzueignen, ein Problem zu lösen oder einige Richtlinien zu lernen, müssen Sie ihnen praktische und nachvollziehbare Beispiele liefern.
Diese Beispiele verbessern die Lesbarkeit Ihrer Arbeit und vermitteln Ihrem Leser komplexe Informationen, indem sie Kontext zu Produkten und Prozessen liefern. Auf diese Weise ist es wahrscheinlicher, dass sie die Produkte bewusst und sicher verwenden.
10. Holen Sie sich vor der Veröffentlichung eine Überprüfung durch einen Drittanbieter ein
Ein technisches Dokument sollte immer einen gemeinsamen Prozess durchlaufen, an dem der Verfasser und der Prüfer beteiligt sind. Eine Überprüfung durch einen Drittanbieter hilft bei der Erstellung eines zielgruppenorientierten, fehlerfreien und wirkungsvollen Dokuments.
Als ursprünglicher Autor des Dokuments haben Sie möglicherweise viele Entwürfe geschrieben, bevor Sie das endgültige Dokument erstellt haben. Unabhängig davon, wie gut Ihr Dokument aussieht, verlassen Sie sich nicht nur auf Ihren Verstand.
Werden Sie noch heute ein professioneller Technischer Redakteur
Das Verständnis der wesentlichen Regeln für technisches Schreiben wird Sie kompetenter und begehrter machen. Viele Unternehmen wissen, wie wichtig es ist, dass ihre Produkte oder Dienstleistungen bei Endbenutzern gut vermarktet werden, und ihnen dabei zu helfen, dies zu erreichen, ist Ihr Ziel als technischer Redakteur.
