Technisches Schreiben - Technical writing

Technische Redaktion ist das Schreiben oder Entwerfen von technischer Kommunikation, die in technischen und beruflichen Bereichen wie Computerhardware und -software , Ingenieurwesen , Chemie , Luftfahrt , Robotik , Finanzen , Medizin , Unterhaltungselektronik , Biotechnologie und Forstwirtschaft verwendet wird . Die Technische Redaktion umfasst den größten Teilbereich der Technischen Kommunikation.

Die Gesellschaft für Technische Kommunikation definiert technische Kommunikation als jede Form der Kommunikation, die eines oder mehrere der folgenden Merkmale aufweist: „(1) Kommunikation über technische oder fachliche Themen wie Computeranwendungen, medizinische Verfahren oder Umweltvorschriften; (2) Kommunikation durch den Einsatz von Technologien wie Webseiten, Hilfedateien oder Social-Media-Sites oder (3) Bereitstellung von Anweisungen, wie etwas zu tun ist, unabhängig davon, wie technisch die Aufgabe ist".

Überblick

Weitere Informationen: Technischer Redakteur

Technisches Schreiben wird von einem technischen Redakteur (oder technischen Autor) durchgeführt und ist der Prozess des Schreibens und Teilens technischer Informationen in einem professionellen Umfeld. Die Hauptaufgabe eines Technischen Redakteurs besteht darin, einer anderen Person oder Partei technische Informationen so klar und effektiv wie möglich zu übermitteln. Die Informationen, die technische Redakteure kommunizieren, sind oft komplex, daher sind starke Schreib- und Kommunikationsfähigkeiten unerlässlich. Technische Redakteure vermitteln nicht nur Informationen durch Text, sondern müssen auch mit Computern umgehen können. Technische Redakteure verwenden eine breite Palette von Programmen, um Illustrationen zu erstellen und zu bearbeiten , Diagrammprogramme, um visuelle Hilfsmittel zu erstellen, und Dokumentprozessoren , um Dokumente zu entwerfen, zu erstellen und zu formatieren.

Während technisches Schreiben häufig mit Online-Hilfe und Benutzerhandbüchern in Verbindung gebracht wird , kann der Begriff technische Dokumentation ein breiteres Spektrum von Genres und Technologien abdecken. Pressemitteilungen , Memos , Berichte , Geschäftsvorschläge , Datenblatt , Produktbeschreibungen und Spezifikationen , White Papers , Resümees und Bewerbungen sind nur einige Beispiele für das Schreiben kann technische Dokumentation in Betracht gezogen werden. Einige Arten von technischer Dokumentation werden normalerweise nicht von technischen Redakteuren bearbeitet. Beispielsweise wird eine Pressemitteilung normalerweise von einem PR-Autor verfasst, obwohl ein technischer Redakteur möglicherweise zu allen technischen Informationen in der Pressemitteilung beitragen kann.

Geschichte

Während die Technische Redaktion erst seit dem Zweiten Weltkrieg als Beruf anerkannt ist , lassen sich ihre Wurzeln bis in die Antike zurückverfolgen . Kritiker zitieren die Werke von Schriftstellern wie Aristoteles als die frühesten Formen des technischen Schreibens. Die Arbeit von Geoffrey Chaucer , Abhandlung über das Astrolabium, ist ein frühes Beispiel für ein technisches Dokument . Die frühesten Beispiele für technisches Schreiben stammen aus der altenglischen Zeit.

Mit der Erfindung des mechanischen Buchdrucks , dem Beginn der Renaissance und dem Aufkommen des Zeitalters der Vernunft wurde die Dokumentation von Erkenntnissen zur Notwendigkeit. Erfinder und Wissenschaftler wie Isaac Newton und Leonardo da Vinci erstellten Dokumente, die ihre Erfindungen und Erkenntnisse aufzeichneten. Während sie während ihrer Veröffentlichungszeit nie als technische Dokumente bezeichnet wurden, spielten diese Dokumente eine entscheidende Rolle bei der Entwicklung moderner Formen der technischen Kommunikation und des Schreibens.

Der Bereich der Technischen Kommunikation wuchs während der Industriellen Revolution . Es bestand ein zunehmender Bedarf, den Menschen Anweisungen zur Verwendung der immer komplexer werdenden Maschinen zu geben, die erfunden wurden. Doch anders als in der Vergangenheit, wo die Fertigkeiten durch mündliche Überlieferungen weitergegeben wurden, wusste niemand außer den Erfindern, wie man diese neuen Geräte benutzt. Das Schreiben wurde somit zum schnellsten und effektivsten Weg, um Informationen zu verbreiten, und Autoren, die diese Geräte dokumentieren konnten, waren begehrt.

Während des 20. Jahrhunderts stieg der Bedarf an technischer Redaktion in die Höhe und der Beruf wurde offiziell anerkannt. Die Ereignisse des Ersten und Zweiten Weltkriegs führten zu Fortschritten in der Medizin, der militärischen Hardware, der Computertechnologie und der Luft- und Raumfahrttechnologie. Dieses schnelle Wachstum, gepaart mit der Dringlichkeit des Krieges, führte zu einem unmittelbaren Bedarf an einer gut gestalteten Dokumentation, um den Einsatz dieser Technologien zu unterstützen. Technisches Schreiben war in dieser Zeit sehr gefragt und "Technischer Redakteur" wurde während des Zweiten Weltkriegs zu einer offiziellen Berufsbezeichnung .

Nach dem Zweiten Weltkrieg führte der technologische Fortschritt zu einem Anstieg der Konsumgüter und des Lebensstandards. Während des Nachkriegsbooms verzeichneten öffentliche Dienste wie Bibliotheken und Universitäten sowie Verkehrssysteme wie Busse und Autobahnen ein erhebliches Wachstum. Der Bedarf an Autoren, diese Prozesse aufzuzeichnen, stieg. In dieser Zeit begannen auch große Unternehmen und Universitäten mit der Verwendung von Computern. Bemerkenswerterweise verfasste Joseph D. Chapline 1949 das erste rechnergestützte technische Dokument, eine Bedienungsanleitung für den BINAC- Computer.

Die Erfindung des Transistors im Jahr 1947 ermöglichte es, Computer billiger und im Einkaufsbereich von Privatpersonen und Kleinunternehmen herzustellen. Als der Markt für diese „ Personal Computer “ wuchs, wuchs auch der Bedarf an Autoren, die diese Geräte erklären und Benutzerdokumentation bereitstellen konnten. Der Beruf des Technischen Redakteurs wurde in den 1970er und 1980er Jahren weiter ausgebaut, als Unterhaltungselektronik in die Wohnungen von immer mehr Menschen Einzug hielt.

In den letzten Jahren hat die Bedeutung von Computern in der Gesellschaft zu vielen Fortschritten auf dem Gebiet der digitalen Kommunikation geführt, was zu Veränderungen bei den Werkzeugen geführt hat, die technische Redakteure verwenden. Hypertext , Textverarbeitungsprogramme , Grafikbearbeitungsprogramme und Seitenlayout-Software haben die Erstellung von technischen Dokumenten schneller und einfacher gemacht, und technische Redakteure müssen heute mit diesen Programmen vertraut sein.

Techniken

Gutes technisches Schreiben ist prägnant, fokussiert, leicht verständlich, fehlerfrei und zielgruppenorientiert. Technische Redakteure konzentrieren sich darauf, ihre Dokumente so klar wie möglich zu gestalten und vermeiden zu technische Phrasen und stilistische Entscheidungen wie Passiv und Nominalisierungen. Da technische Dokumente in realen Situationen verwendet werden, sollte immer explizit klar sein, was der Gegenstand eines technischen Dokuments ist und wie die präsentierten Informationen verwendet werden. Es wäre verheerend, wenn zum Beispiel die Anleitung eines Technischen Redakteurs zum Umgang mit einem Hochleistungs-Röntgengerät schwer zu entziffern wäre.

Technisches Schreiben erfordert, dass ein Autor sein Publikum eingehend untersucht. Ein technischer Redakteur muss sich des vorhandenen Wissens seines Publikums über das von ihm diskutierte Material bewusst sein, da die Wissensbasis des Publikums des Redakteurs den Inhalt und den Fokus eines Dokuments bestimmt. So wird beispielsweise ein Evaluierungsbericht, der die Ergebnisse einer wissenschaftlichen Studie diskutiert und an eine Gruppe hochqualifizierter Wissenschaftler verfasst wird, ganz anders aufgebaut sein als ein für die breite Öffentlichkeit gedachter. Technische Redakteure müssen selbst keine Fachexperten (KMU) sein. Sie arbeiten oft mit KMU zusammen, um Aufgaben zu erledigen, die mehr Wissen über ein Thema erfordern, als sie besitzen.

Technisches Schreiben muss korrekt sein. Ein technischer Redakteur weiß nach der Analyse seines Publikums, was er kommunizieren muss, und muss die Botschaft dann auf genaue und ethische Weise vermitteln. Wenn ein Autor dies falsch macht, können physische, ökologische oder finanzielle Auswirkungen dies sein. Die Kenntnis des Publikums ist für die Genauigkeit von entscheidender Bedeutung, da die Sprache darauf zugeschnitten ist, was es bereits über das jeweilige Thema versteht. Zum Beispiel sind Anweisungen zum richtigen und sicheren Zusammenbauen eines Bücherregals beim Kauf enthalten. Diese Anweisungen sind so aufgebaut, dass jeder sie mitverfolgen kann, einschließlich genauer Details darüber, wo jedes Befestigungselement angebracht ist. Wenn diese Anweisungen ungenau waren, könnte das Bücherregal instabil sein und ausfallen.

Dokumentdesign und -layout sind ebenfalls wichtige Bestandteile der technischen Redaktion. Technische Redakteure verbringen viel Zeit damit, sicherzustellen, dass ihre Dokumente lesbar sind, da ein schlecht gestaltetes Dokument das Verständnis des Lesers beeinträchtigt. Das technische Dokumentdesign betont die richtige Verwendung von Dokumentdesign-Optionen wie Aufzählungszeichen, Schriftgröße und fetter Text. Bilder, Diagramme und Videos werden auch häufig von technischen Redakteuren verwendet, da diese Medien komplexe Informationen wie den Jahresumsatz eines Unternehmens oder die Designmerkmale eines Produkts oft viel effizienter vermitteln können als Text.

Technische Dokumente

Technisches Schreiben deckt viele Genres und Schreibstile ab, abhängig von der Information und dem Publikum. Technische Unterlagen werden nicht nur von Technischen Redakteuren erstellt. Fast jeder, der in einem professionellen Umfeld arbeitet, erstellt technische Dokumente unterschiedlicher Art. Einige Beispiele für technische Dokumentation sind:

  • Anweisungen und Verfahren sind Dokumente, die entweder Entwicklern oder Endbenutzern bei der Bedienung oder Konfiguration eines Geräts oder Programms helfen. Beispiele für Anleitungsdokumente umfassen Benutzerhandbücher und Anleitungen zur Fehlerbehebung für Computerprogramme, Computerhardware, Haushaltsprodukte, medizinische Geräte, mechanische Produkte und Kraftfahrzeuge.
  • Vorschläge . Die meisten Projekte beginnen mit einem Vorschlag – einem Dokument, das den Zweck eines Projekts, die Aufgaben, die im Projekt durchgeführt werden, die Methoden zum Abschluss des Projekts und schließlich die Kosten des Projekts beschreibt. Die Vorschläge decken ein breites Themenspektrum ab. Zum Beispiel kann ein technischer Redakteur einen Vorschlag verfassen, in dem die Kosten für die Installation eines neuen Computersystems beschrieben werden, ein Marketingfachmann kann einen Vorschlag mit den Produktangeboten schreiben und ein Lehrer kann einen Vorschlag schreiben, der beschreibt, wie ein neuer Biologieunterricht wird strukturiert.
  • E-Mails , Briefe und Memoranden gehören zu den am häufigsten geschriebenen Dokumenten in einem Unternehmen. Briefe und E-Mails können mit einer Vielzahl von Zielen erstellt werden – einige zielen normalerweise darauf ab, einfach Informationen zu übermitteln, während andere den Empfänger davon überzeugen sollen, eine bestimmte Aufgabe zu erfüllen. Während Briefe normalerweise an Personen außerhalb eines Unternehmens geschrieben werden, sind Memoranden (Memos) Dokumente, die an andere Mitarbeiter innerhalb des Unternehmens geschrieben werden.
  • Pressemitteilungen . Wenn ein Unternehmen ein neues Produkt oder eine neue Dienstleistung öffentlich enthüllen möchte, wird ein Autor eine Pressemitteilung erstellen . Dies ist ein Dokument, das die Funktionen und den Wert des Produkts für die Öffentlichkeit beschreibt.
  • Spezifikationen sind Entwurfsskizzen, die die Struktur, Teile, Verpackung und Lieferung eines Objekts oder Prozesses so detailliert beschreiben, dass eine andere Partei es rekonstruieren kann. Zum Beispiel könnte ein technischer Redakteur die Spezifikationen für ein Smartphone oder Fahrrad zeichnen und schreiben, damit ein Hersteller das Objekt herstellen kann.
  • Beschreibungen sind kürzere Erklärungen von Verfahren und Prozessen, die dem Leser helfen, zu verstehen, wie etwas funktioniert. Ein technischer Redakteur könnte beispielsweise ein Dokument verfassen, das die Auswirkungen von Treibhausgasen zeigt oder die Funktionsweise des Bremssystems eines Fahrrads demonstriert.
  • Lebensläufe und Bewerbungen sind ein weiteres Beispiel für technische Dokumente. Es handelt sich um Dokumente, die in einem professionellen Umfeld verwendet werden, um die Leser über die Referenzen des Autors zu informieren.
  • Technische Berichte werden verfasst, um den Lesern Informationen, Anweisungen und Analysen für Aufgaben zu bieten. Berichte gibt es in vielen Formen. Ein technischer Redakteur kann beispielsweise ein zum Verkauf stehendes Gebäude bewerten und einen Reisebericht erstellen, der seine Ergebnisse hervorhebt und ob er oder sie der Meinung ist, dass das Gebäude gekauft werden sollte. Ein anderer Autor, der für ein gemeinnütziges Unternehmen arbeitet, kann einen Bewertungsbericht veröffentlichen, der die Ergebnisse der Forschung des Unternehmens zur Luftverschmutzung zeigt.
  • Fallstudie ist ein veröffentlichter Bericht über eine Person, Gruppe oder Situation, der im Laufe der Zeit untersucht wurde; auch  : eine Situation im wirklichen Leben, die betrachtet oder studiert werden kann, um etwas zu lernen. Die herausfordernde Situation einer Person an ihrem Arbeitsplatz und wie sie diese gelöst hat, ist beispielsweise eine Fallstudie.
  • Whitepapers sind Dokumente, die für Experten auf einem Gebiet geschrieben wurden und in der Regel eine Lösung für eine technologische oder geschäftliche Herausforderung oder ein Problem beschreiben. Beispiele für Whitepaper sind ein Artikel, in dem beschrieben wird, wie sich ein Unternehmen auf dem Markt abhebt, oder ein Artikel, der erklärt, wie Cyberangriffe auf Unternehmen verhindert werden können.
  • Webseiten . Das Aufkommen von Hypertext hat die Art und Weise verändert, wie Dokumente gelesen, organisiert und aufgerufen werden. Technische Redakteure von heute sind oft für die Erstellung von Seiten auf Websites wie "Über uns"-Seiten oder Produktseiten verantwortlich. Von ihnen wird oft erwartet, dass sie mit Webentwicklungstools vertraut sind.
  • Datenblätter sind die Dokumente, die die Funktionen, wichtigsten Spezifikationen, technischen Eigenschaften, Anwendungsschaltkreise und einige andere wichtige Informationen über das Produkt, die Maschine, die Ausrüstung, die Software, die Anwendung oder das System in Kürze zusammenfassen.
  • API-Leitfäden werden für die Entwicklergemeinschaft geschrieben und dienen zur Erläuterung der Anwendungsprogrammierschnittstellen .
  • Hilfesysteme sind Online - Hilfe - Zentren , die Benutzer mit technischen Informationen über Produkte und Dienstleistungen. Sie stellen Inhalte als Webseiten bereit, die in einem Browser angezeigt werden. Der Inhalt kann in Help-Center-Software wie Zendesk oder in Hilfe-Authoring-Tools oder Komponenten-Content-Management-Systemen erstellt werden , die ein Help-Center als HTML-Ausgabe erstellen können.

Werkzeuge

Die folgenden Tools werden von technischen Redakteuren verwendet, um Dokumente zu erstellen und zu präsentieren:

  • Desktop-Publishing-Tools oder Textverarbeitungsprogramme . Technische Redakteure verwenden Textverarbeitungsprogramme wie Scrivener, Microsoft Word , Apple Pages und LibreOffice Writer , um Dokumente zu erstellen, zu bearbeiten, zu entwerfen und zu drucken. Da es bei der technischen Redaktion ebenso um das Seitenlayout wie um die geschriebene Sprache geht, werden auch erweiterte Desktop-Publishing-Tools wie Adobe InDesign und LyX verwendet. Diese Programme funktionieren ähnlich wie Textverarbeitungsprogramme, bieten den Benutzern jedoch mehr Optionen und Funktionen für das Design des Dokuments und automatisieren einen Großteil der Formatierung.
  • Hilfe zur Erstellung von Tools . Diese werden von technischen Redakteuren verwendet, um die Hilfesysteme zu erstellen, die mit Softwareprodukten verpackt, über Webbrowser bereitgestellt oder als Dateien bereitgestellt werden, die Benutzer auf ihren Computern anzeigen können. Beim Schreiben von Anleitungen zur Beschreibung von mechanischen, elektrischen oder Softwareprogrammen verwenden technische Redakteure diese Tools, um sie bei der Vereinfachung von Montage-, Betriebs- oder Installationsvorgängen zu unterstützen.
  • Komponenten-Content-Management-Systeme . Diese werden auch von Technischen Redakteuren verwendet, um Hilfesysteme und Dokumente zu erstellen. Komponenten-Content-Management-Systeme (CCMS) ermöglichen es Autoren, ähnliche Ausgaben wie Tools zum Erstellen von Hilfen zu erstellen, bieten aber auch Content-Management-Funktionen wie Versionsverwaltung und integrierte Workflows.
  • Bildbearbeitungssoftware . Oft können Bilder und andere visuelle Elemente Informationen besser vermitteln als Textabsätze. In diesen Fällen werden Bildbearbeitungssoftware wie Adobe Photoshop und GIMP von technischen Redakteuren verwendet, um die visuellen Aspekte von Dokumenten wie Fotos, Symbolen und Diagrammen zu erstellen und zu bearbeiten.
  • Kollaborative Softwareprogramme. Da technisches Schreiben oft die Kommunikation zwischen mehreren Personen beinhaltet, die für verschiedene Unternehmen arbeiten, kann es sich um eine kollaborative Angelegenheit handeln. Technische Redakteure verwenden Wiki-Systeme und gemeinsame Dokumentarbeitsbereiche, um mit anderen Redakteuren und Parteien zusammenzuarbeiten, um technische Dokumente zu erstellen.
  • Tools zur Webentwicklung . Die Jobs des Technischen Redakteurs beschränken sich nicht mehr nur auf die Erstellung von Dokumenten. Manchmal produzieren sie auch Inhalte für die Unternehmens- und andere professionelle Websites eines Unternehmens. Von technischen Redakteuren kann daher erwartet werden, dass sie mit Webentwicklungstools wie Adobe Dreamweaver vertraut sind .
  • Texteditoren . Programme wie Microsoft Notepad , TextEdit oder Wordstar ermöglichen es Technischen Redakteuren, Klartext zu bearbeiten. Texteditoren können verwendet werden, um Inhalte wie Konfigurationsdateien , Dokumentationsdateien und Quellcode der Programmiersprache zu ändern. Texteditoren werden häufig von technischen Redakteuren verwendet, die mit Online-Inhalten arbeiten.
  • Grafiksoftware. Um statistische Informationen wie die Anzahl der Restaurantbesuche oder den Geldbetrag, den eine Universität für ihre Sportprogramme ausgibt, zu kommunizieren, verwenden technische Redakteure Grafiken und Flussdiagramme. Während Programme wie Microsoft Excel und Word grundlegende Grafiken und Diagramme erstellen können, müssen technische Redakteure manchmal komplexere und detailliertere Grafiken erstellen, die Funktionen erfordern, die in diesen Programmen nicht verfügbar sind, und müssen möglicherweise auf Grafik- und Diagrammtools (z. B. Microsoft Visio ) zurückgreifen .
  • Screenshot-Tools. Technische Redakteure verwenden häufig Screen-Capture-Tools wie Camtasia und Snagit . Beim Erstellen von Anweisungen für Computersoftware kann es für einen technischen Redakteur einfacher sein, einfach ein kurzes Video von seinem Desktop aufzunehmen, während er eine Aufgabe erledigt, als eine lange Reihe von Anweisungen zu schreiben, die beschreiben, wie die Aufgabe ausgeführt werden muss. Screenshot-Tools werden auch verwendet, um Screenshots von Programmen und Software, die auf den Computern der Benutzer ausgeführt werden, zu erstellen und dann begleitende Diagramme zu erstellen.

Liste der Verbände

Verweise

Externe Links