Technisches Schreiben meistern: 13 Schritte (mit Bildern)

Inhaltsverzeichnis:

Technisches Schreiben meistern: 13 Schritte (mit Bildern)
Technisches Schreiben meistern: 13 Schritte (mit Bildern)
Anonim

Die Technische Redaktion ist einer der am schnellsten wachsenden Berufe und die Nachfrage nach Technischen Redakteuren zeigt keine Anzeichen einer Verlangsamung. Vielleicht haben Sie Grundkenntnisse in der Technischen Redaktion und möchten sich als Technischer Redakteur beruflich weiterentwickeln, oder vielleicht arbeiten Sie bereits seit mehreren Jahren als Technischer Redakteur und möchten Ihre Fähigkeiten erweitern. Das Beherrschen des technischen Schreibens erfordert jahrelange Erfahrung, Übung und ständiges Erweitern Ihrer Fähigkeiten, um mit den Anforderungen der Branche auf dem Laufenden zu bleiben.

Schritte

Teil 1 von 3: Technisches Schreiben verstehen

Master Technical Writing Schritt 1

Schritt 1. Seien Sie sich der erforderlichen Fähigkeiten bewusst, um ein technischer Redakteur zu sein

Anders als kreatives Schreiben oder meinungsbasiertes Schreiben sollte technisches Schreiben einem Leser helfen, einen Prozess, ein Produkt oder ein Thema auf klare und prägnante Weise zu verstehen. Technisches Schreiben wird nicht geschrieben, um den Leser zu unterhalten oder abzulenken. Stattdessen sollte es informativ und klar sein. Technische Redakteure, auch Technische Redakteure genannt, erstellen Dokumente wie Bedienungsanleitungen, Zeitschriftenartikel und Designdokumente, die Informationen für Kunden, Verbraucher, Designer und Hersteller enthalten.

  • Als technischer Redakteur können Sie auch Montageanleitungen, Benutzerhandbücher, wissenschaftliche Aufsätze, medizinische Aufsätze, Broschüren sowie Mitarbeiter- und Studentenhandbücher schreiben.
  • Außerdem sollten Sie ein gutes Auge für Details haben und in der Lage sein, klar und prägnant zu kommunizieren. Die meisten technischen Redakteure sind gute Lehrer und können Regeln oder Richtlinien auf lehrreiche Weise erklären. Darüber hinaus sollten Sie über umfassende Kenntnisse in Bezug auf Zeichensetzung, Syntax und Stil sowie ein starkes Verständnis für Satzstruktur und Grammatik verfügen.
Master Technical Writing Schritt 2

Schritt 2. Erinnern Sie sich an die Schlüsselelemente, um ein effektiver technischer Redakteur zu sein

Starke technische Redakteure planen ihre Dokumente, bevor sie sie schreiben, und geben die Informationen klar, kurz und einfach an. Sie werden auch die richtige Wortwahl verwenden, die aktive Stimme so oft wie möglich verwenden und verstehen, dass technisches Schreiben ein Prozess ist, der möglicherweise eine Bearbeitung oder Überarbeitung erfordert. Die Planung Ihrer schriftlichen Dokumente ist einer der wichtigsten Schritte bei der Erstellung aussagekräftiger technischer Texte für einen Kunden. Folgende Elemente sollten Sie bei der Planung beachten:

  • Identifizieren Sie Ihr Publikum und seine Erwartungen.
  • Verstehen Sie den Zweck des Dokuments.
  • Organisieren Sie Ihre Begleitmaterialien und skizzieren Sie das Dokument.
  • Planen Sie die erforderliche Zeit zum Schreiben, Überarbeiten und Bearbeiten des Dokuments ein.
Master Technical Writing Schritt 3

Schritt 3. Verstehen Sie die wachsende Nachfrage nach technischen Redakteuren

Technisches Schreiben ist ein wachsendes Feld, insbesondere in den Vereinigten Staaten. Das Bureau of Labor Statistics prognostiziert, dass die Jobs im Bereich Technisches Schreiben 15 Prozent schneller als der Durchschnitt für alle Berufe wachsen werden. Tatsächlich ist das Technische Schreiben eine der gefragtesten Fähigkeiten von Arbeitgebern, insbesondere da der Technologiesektor weiter wächst. Die Fähigkeit, effektiv zu kommunizieren und die Leser über eine Vielzahl von Themen zu unterrichten, macht Sie zu einem sehr begehrten Kandidaten auf dem Arbeitsmarkt.

Im Mai 2012 betrug der durchschnittliche Jahreslohn für Technische Redakteure 65.500 US-Dollar. Die meisten Technischen Redakteure haben einen Hochschulabschluss in Technischer Redaktion oder einem verwandten Bereich sowie einige Erfahrung in einem technischen Fach wie Informatik, Webdesign oder Ingenieurwesen. Viele Hochschulen bieten auch Zertifikatsstudiengänge in der Technischen Redaktion an

Teil 2 von 3: Verbessern Sie Ihren Schreibstil und Ihre Herangehensweise

Master Technical Writing Schritt 4

Schritt 1. Konzentrieren Sie sich in Ihren Dokumenten auf rhetorisches Bewusstsein und benutzerzentriertes Design

Neben dem einfachen Schreiben von Dokumenten, die einen Prozess oder ein Produkt erklären, sind starke technische Redakteure auch in der Rhetorik geübt. So können Sie überzeugend und eloquent über den Prozess oder das Produkt schreiben. Anstatt Vorlagen oder Richtlinien zu reproduzieren, sollten Sie die Ziele und Situationen rund um das Dokument berücksichtigen. Auf diese Weise können Sie effektiver mit der Zielgruppe kommunizieren und den Prozess oder das Produkt benutzerfreundlicher erklären. Unabhängig davon, welche Art von technischem Dokument Sie erstellen, sollten Sie immer Ihre beabsichtigte Zielgruppe berücksichtigen und das Dokument benutzerzentriert gestalten. Dadurch wird Ihr Dokument für Ihren Leser zugänglich und verständlich. Um rhetorisch zu schreiben, müssen Sie die rhetorische Situation eines Dokuments gut verstehen:

  • Bestimmen Sie die Erwartungen des Publikums. Fragen Sie sich: Welche Informationen erwarten meine Leser von diesem Dokument? Welche Informationen muss ich den Lesern zur Verfügung stellen?
  • Denken Sie an die Eigenschaften des Publikums. Überlegen Sie, wer das Dokument liest. Ist Ihr Publikum in Bezug auf den Stil und die Organisation der Dokumente Teil des Entscheidungsprozesses, z. B. Stakeholder und Management? Ist das Publikum die breite Öffentlichkeit oder der durchschnittliche Leser? Wie wirken sich die Merkmale des Publikums auf die Dokumenterwartungen aus? Das Schreiben eines Dokuments für ein Publikum, das mit den Informationen vertraut ist, erzeugt einen anderen Ton als das Schreiben eines Dokuments für ein Publikum, das keine Spezialisten oder allgemeine Benutzer ist. Sie sollten auch das Leseniveau Ihres Publikums berücksichtigen. Ihr Client kann die Lesestufe angeben und Sie sollten in diese Lesestufe schreiben.
  • Betrachten Sie die Ziele des Publikums. Was hat Ihr Leser vor? Was soll Ihr Leser aus dem Dokument lernen? Sie sollten sicherstellen, dass das Dokument alle notwendigen Informationen enthält, damit Ihr Leser sein Ziel oder seine Ziele erreichen kann.
Master Technical Writing Schritt 5

Schritt 2. Versuchen Sie einen aufgabenbasierten Ansatz, um die Informationen zu organisieren

Organisation ist ein Schlüsselelement, um ein starker technischer Redakteur zu sein, und eine der einfachsten Möglichkeiten, Rohinformationen oder Daten zu organisieren, besteht darin, sie in eine Reihe von Aufgaben aufzuteilen, gefolgt von Anweisungen für jede Aufgabe.

  • Überlegen Sie, wie viele Aufgaben das Verfahren umfasst, über das Sie schreiben. Eine Aufgabe ist eine halbunabhängige Gruppe von Aktionen innerhalb einer Prozedur. Zum Beispiel ist das Einstellen der Uhr an einem Ofen eine Aufgabe beim Betrieb eines Ofens. Einige Prozeduren enthalten nicht mehr als eine Aufgabe, zum Beispiel das Auswechseln einer Glühbirne. Aber auch komplexere Verfahren, wie das Bedienen eines Ofens oder das Finden einer Glühbirne für eine bestimmte Leuchte, beinhalten mehrere Aufgaben.
  • Um eine lange Liste von Aufgaben zu organisieren, gruppieren Sie ähnliche oder verwandte Aufgaben in Schritten. Gruppieren Sie diese Schritte dann in Phasen oder Phasen. Nummerieren Sie jeden Schritt in einer Phase oder einem Stadium. Zum Betrieb eines Ofens können Sie beispielsweise eine Phase mit dem Titel Einrichten des Ofens haben, mit Schritten zum Anschließen des Ofens an eine Stromquelle, zum Einstellen der Uhr, zum Bestätigen der Temperatureinstellungen und zum Überprüfen, ob das Gebläse und die Ofenbeleuchtung einmal richtig funktionieren der Backofen ist angeschlossen.
  • Sie können die Informationen auch nach Werkzeugen statt nach Aufgaben organisieren. Betrachten Sie die Werkzeuge, die dem Benutzer des Produkts zur Verfügung stehen, beispielsweise dem Benutzer eines Ofens. In einem Tools-Ansatz können Sie einen Abschnitt für die Stromquelle des Ofens, die Ofenuhr, die Temperatureinstellung, das Gebläse und die Ofenbeleuchtung erstellen. Es kann jedoch schwierig sein, einen Tools-Ansatz für die technische Redaktion zu verwenden, der kein Produkt oder Element umfasst. In der technischen Redaktion verwenden Sie häufig einen Aufgabenansatz, insbesondere wenn Sie über einen Prozess schreiben.
Master Technical Writing Schritt 6

Schritt 3. Verwenden Sie die aktiven Sprach- und Aktionsverben

Stärken Sie Ihren Sprachgebrauch in einem Dokument, indem Sie die aktive Stimme anstelle der passiven Stimme verwenden. Das Beschreiben eines Vorgangs im Aktiv mit Aktionsverben verleiht Ihrem Schreiben Unmittelbarkeit und Klarheit.

  • Anstatt beispielsweise ein Dokument mit der Bedienung eines Backofens mit: „Stecken Sie den Backofen in die Stromquelle“zu beginnen, verwenden Sie ein stärkeres Verb wie „plug“oder „connect“. Sie können auch andere Aktionsverben in aktiven Sätzen verwenden, wie „Stellen Sie die Ofenuhr“, „Bestimmen Sie Ihre ideale Temperatureinstellung“und „Bestätigen Sie, dass der Ventilator und die Backofenlampe ordnungsgemäß funktionieren“.
  • Sie sollten auch sicherstellen, dass Ihre Sätze so oft wie möglich die aktive Stimme verwenden. Möglicherweise haben Sie einen Satz, der das Passiv verwendet, wie zum Beispiel: "Leichter Druck auf die Ofentür sollte ausgeübt werden, um sicherzustellen, dass sie richtig geschlossen ist." Passen Sie dies an die aktive Stimme an, bei der der Betreff des Satzes die Aktion im Satz ausführt: "Üben Sie leichten Druck auf die Ofentür aus, um sicherzustellen, dass sie richtig geschlossen ist."
Master Technical Writing Schritt 7

Schritt 4. Vereinfachen Sie nach Möglichkeit alle Begriffe oder Phrasen

Wenn Sie in Ihren Dokumenten Jargon oder Slang verwenden, sollten Sie überlegen, ob Ihr Publikum diesen Jargon versteht. Wenn ihnen der Jargon nicht bekannt ist, müssen Sie diese unbekannten Begriffe definieren oder diese Begriffe durch eine vereinfachte Sprache ersetzen. Eine gute Faustregel ist, niemals zwei Wörter zu verwenden, wenn ein Wort ausreicht. Konzentrieren Sie sich darauf, Ihre Sprache zu reduzieren, damit Ihrem Leser die wesentliche Bedeutung klar ist und die Bedeutung nicht mit unnötigen Informationen oder Begriffen überladen wird.

  • Vermeiden Sie unnötige Komplexität, die auftritt, wenn Sie formale Begriffe verwenden, die Ihren Leser verwirren oder abschrecken können. Anstatt beispielsweise „utilize“zu schreiben, können Sie „use“schreiben, anstatt „finalize“zu schreiben, Sie können „end“schreiben, anstatt „functionity“zu schreiben, können Sie „feature“schreiben.
  • Häufig werden Fachbegriffe in Dokumenten abgekürzt. Sie sollten die Abkürzungen immer buchstabieren, wenn sie zum ersten Mal in einem Abschnitt erwähnt werden, und dann die Abkürzung im Rest des Abschnitts verwenden, um Redundanz zu vermeiden.
Master Technical Writing Schritt 8

Schritt 5. Integrieren Sie Grafiken und visuelle Hilfsmittel

Viele technische Redaktionsdokumente können durch die Verwendung von Grafiken oder visuellen Hilfsmitteln verbessert werden, um Ihren Leser zu beschäftigen und ein visuelles Beispiel für den Prozess zu bieten. Es kann schwierig sein, einen komplexen Vorgang mit Worten zu erklären, und die Verwendung einer Illustration kann Ihrem Leser helfen, den Vorgang noch besser zu verstehen.

Möglicherweise stellt Ihr Kunde visuelle Hilfsmittel oder Grafiken zur Verfügung, die in das technische Redaktionsdokument integriert werden müssen, oder Sie müssen diese Grafiken an einen Illustrator auslagern. Schlagen Sie visuelle Hilfsmittel vor, wenn Ihr Kunde sich ihrer Verwendung noch nicht bewusst ist. Der von Grafiken bereitgestellte Leerraum kann auch die geschriebenen Beschreibungen aufbrechen und Ihrem Leser die Möglichkeit geben, die Informationen zu verdauen

Master Technical Writing Schritt 9

Schritt 6. Formatieren Sie Ihre Dokumente gemäß dem Styleguide des Kunden

Die meisten Kunden stellen einen Styleguide zur Verfügung, der ihre Erwartungen an das Dokument in Bezug auf Sprache, Grammatik, Zeichensetzung, Syntax und Stil umreißt. Sie sollten beim Formatieren eines technischen Redaktionsdokuments immer die Richtlinien des Kunden befolgen. Vermeiden Sie es, Dokumente einzureichen, die nicht richtig formatiert sind oder nicht dem Styleguide des Kunden entsprechen. Dies wird unprofessionell und schlampig erscheinen.

Master Technical Writing Schritt 10

Schritt 7. Seien Sie auf Überarbeitungen und Neuschreibungen vorbereitet

Technische Redaktionsdokumente durchlaufen oft mehrere Überarbeitungen und Überarbeitungen, bevor sie vom Kunden als endgültig betrachtet werden. Sie müssen eine offene Kommunikation mit Ihren Kunden pflegen, um sicherzustellen, dass sie ein endgültiges Dokument erhalten, mit dem sie zufrieden sind. Vermeiden Sie es, Änderungen oder Überarbeitungen persönlich zu nehmen. Sie arbeiten für einen Kunden und schreiben für die Bedürfnisse eines Kunden.

Viele technische Redakteure erstellen mehrere Versionen von Dokumenten, um Überarbeitungen oder Anpassungen zu verfolgen. Möglicherweise arbeiten Sie an mehreren Projekten gleichzeitig, insbesondere wenn Sie freiberuflicher technischer Redakteur sind. Halten Sie Ihre Dokumente also organisiert, um Überarbeitungen einfach und schnell zu machen

Teil 3 von 3: Verwenden von Kursen für technisches Schreiben und professionellen Ressourcen

Master Technical Writing Schritt 11

Schritt 1. Nehmen Sie an einem Weiterbildungskurs für technisches Schreiben teil

Verbessern Sie Ihre Schreibfähigkeiten in einem Weiterbildungskurs zum Technischen Schreiben und gewinnen Sie mehr Einblicke in die Beherrschung des Technischen Schreibens. Viele Kurse konzentrieren sich auf bestimmte Elemente des technischen Schreibens, wie z. B. das Bewusstsein des Publikums, die Organisation von Informationen, die Verwendung von visuellen Hilfsmitteln und die Vereinfachung der Sprache entsprechend dem Leseniveau des Publikums.

Überlegen Sie, in welchen Bereichen des Technischen Schreibens Sie sich verbessern möchten und welcher Kurs am nützlichsten wäre, um Ihre Fähigkeiten als Technischer Redakteur zu erweitern

Master Technical Writing Schritt 12

Schritt 2. Nehmen Sie an einer Konferenz für technisches Schreiben teil

Technische Redaktionskonferenzen können gute Orte sein, um andere Autoren der Branche zu treffen und einen möglichen Mentor zu finden, der Sie in Ihrer Karriere begleitet. Seien Sie bereit, sich auf diesen Konferenzen zu vernetzen und scheuen Sie sich nicht vor Ihren Kollegen. Viele Konferenzen veranstalten auch Panels und Seminare, um Ihnen zu helfen, Ihre vorhandenen technischen Schreibfähigkeiten zu verbessern.

Master Technical Writing Schritt 13

Schritt 3. Treten Sie einem professionellen Verband für technische Redaktionen bei

Ein professioneller Verband für Technische Redaktion, wie die Society for Technical Communication (STC), kann Ihnen helfen, andere Fachleute zu treffen und über die neuesten Entwicklungen in der Branche der Technischen Redaktion auf dem Laufenden zu bleiben. Viele Arbeitgeber sehen auch die Mitgliedschaft in einem Berufsverband als Vorteil und ein Zeichen dafür, dass Sie verbunden und mit den aktuellen Entwicklungen in der Branche vertraut sind.

Beliebt nach Thema