Was ist Technische Redaktion? Definition und Beispiele

Es ist leicht, eine gute technische Dokumentation als selbstverständlich anzusehen. Wenn die technische Kommunikation gut gemacht ist, lassen sie komplexe Tools einfach zu bedienen und zu warten erscheinen. Aber dieses polierte Furnier ist das Ergebnis von hohem Können und harter Arbeit.

Was ist Technische Redaktion? Lesen Sie weiter für eine Definition und Beispiele.

Was macht ein Technischer Redakteur?

Technische Redaktion, auch Technische Kommunikation genannt, vermittelt Informationen über Technik klar und verständlich. Einige technische Texte dienen einem spezialisierten Publikum und verwenden hochrangige Branchenterminologie. Einige Dokumente richten sich an ein allgemeines Publikum, indem sie komplexe Informationen zusammenfassen.

Diese Art des Schreibens ist ein entscheidendes Kommunikationsmittel für viele Branchen, von der Softwareentwicklung bis zur Fertigung. Es ist in allen Aspekten der Geschäftstätigkeit eines Unternehmens präsent, von Geschäftsplänen bis hin zum Projektmanagement.

Arten des Technischen Schreibens

Technologieunternehmen und Produkthersteller erstellen viele Arten von Dokumenten. Einige, wie Benutzerhandbücher und Schnellstartanleitungen, sind der breiten Öffentlichkeit bekannt. Andere Arten von technischem Schreiben, wie Fallstudien und Whitepaper, erscheinen überhaupt nicht technisch – und das macht sie wertvoll.

Nachfolgend finden Sie eine Einführung in die gängigsten Inhaltskategorien sowie Beispiele für technisches Schreiben, damit Sie sich diese besser vorstellen können.

Produktdokumentation

Produktdokumentation, auch technische Dokumentation genannt, ist das, was sich die meisten Menschen vorstellen, wenn sie sich technisches Schreiben vorstellen. Es erklärt, wie das Produkt funktioniert und/oder wie man es benutzt – zwei sehr unterschiedliche Ziele für den Technischen Redakteur.

Produkthandbücher

Ein Produkthandbuch, manchmal auch als Benutzer- oder Besitzerhandbuch bezeichnet, ist eine umfassende Übersicht über ein technisches Produkt. Wenn es gut geschrieben ist, ist es das einzige Dokument, das ein Benutzer benötigt, um täglich mit einem Produkt zu arbeiten.

Wenn Sie ein Autobesitzer sind, haben Sie wahrscheinlich ein Beispiel für ein Produkthandbuch in Ihrem Handschuhfach. Auto-Benutzerhandbücher beschreiben alle Komponenten, auf die ein Fahrer zugreifen muss, von den Reifen bis zum Onboard-Diagnose-(OBD)-Signalsystem. Sie enthalten auch Anweisungen für die Wartung zu Hause, wie z. B. das Prüfen des Reifendrucks:

1. Entfernen Sie die Reifenventilkappe.
   2. Drücken Sie die Spitze des Reifenfüllmessers auf das Reifenventil.
   3. Lesen Sie den Druck anhand der Skaleneinteilung des Manometers ab.
   4. Wenn der Reifenfülldruck nicht dem empfohlenen Wert entspricht, passen Sie den Druck an. Wenn Sie zu viel Luft hinzufügen, drücken Sie auf die Mitte des Ventils, um die Luft abzulassen.
   5. Nach Abschluss der Messung und Einstellung des Reifenfülldrucks Seifenwasser auf das Ventil auftragen und auf Lecks prüfen.
   6. Setzen Sie die Reifenventilkappe wieder auf.1

Autohandbücher sind für Verbraucher konzipiert. Daher verwenden sie Alltagssprache und nicht-technische Diagramme. Ein Produkthandbuch für einen industriellen Anwender würde ganz anders aussehen.

Während ein Verbraucherhandbuch frei von Jargon sein sollte, kann ein Industriehandbuch eine Terminologie verwenden, die ein Fachmann verstehen würde:

Schließen Sie die Abgasleitung an ein Abgasreinigungssystem mit ausreichendem Durchsatz an, falls der Prozess dies erfordert. Die DRYVAC-Pumpen werden wegen Überdruck abgeschaltet, wenn das Abgasreinigungssystem zu klein ist.2

Benutzer dieser Industrievakuumpumpe würden die Terminologie verstehen. Definitionen sind nicht nötig.

Benutzerleitfäden

Selbst in der Branche der technischen Kommunikation wird oft über den Unterschied zwischen einem Handbuch und einem Leitfaden diskutiert. Der allgemeine Konsens besteht darin, dass ein Leitfaden ein weiter gefasster Begriff ist, der jede Art von Anleitungsdokumentation umfasst, die für den Benutzer bestimmt ist.

Am wichtigsten ist, dass ein Benutzerhandbuch kein langes, detailliertes technisches Dokument sein muss. Es kann ein Anleitungsvideo sein, das auf eine bestimmte Funktion abzielt, oder eine Beilage, die die Tasten Ihrer neuen Uhr erklärt.

Ein Beispiel ist die Schnellstartanleitung, die Sie in der Verkaufsverpackung der meisten Unterhaltungselektronik finden. Heutzutage sind viele Schnellstartanleitungen reich an Illustrationen und enthalten nur bei Bedarf Text. Andere enthalten grundlegende Anweisungen neben Illustrationen, wie in dieser Anleitung für die Ninja Coffee Bar:

• Drehen Sie den Wasserbehälter gegen den Uhrzeigersinn und entfernen Sie ihn zum einfachen Befüllen.
• Füllen Sie frisches, gefiltertes Wasser bis zur Karaffenlinie ein, die auf der Außenseite des Wasserbehälters markiert ist. Auto-iQ kennt genau die richtige Wassermenge, um daraus für die von Ihnen gewählte Größe und Zubereitung zu schöpfen. Stellen Sie vor dem Brühen immer sicher, dass der Wasserbehälter über die Mindestfülllinie für Ihre gewünschte Größe gefüllt ist.
• Drehen Sie den Wasserbehälter im Uhrzeigersinn, bis er einrastet.3

Beachten Sie, dass die Anleitung nicht erklärt, wie Sie den Behälter reparieren oder was zu tun ist, wenn Ihre Kaffeemaschine nicht funktioniert. Dazu benötigen Sie das vollständige Produkthandbuch.

API-Dokumentation

Die Dokumentation von Anwendungsprogrammierschnittstellen (API) ist in der heutigen hypervernetzten Welt allgegenwärtig.

Eine API ist eine Reihe von Funktionen und Anweisungen, die es einem Programm ermöglichen, mit einem anderen zu kommunizieren. Hinter der Option "Bezahlen mit PayPal" in Ihrem bevorzugten Online-Shop steckt eine API. Es unterstützt die „Login with Facebook“-Funktion, die die Anmeldung bei verschiedenen Apps vereinfacht.

Damit APIs funktionieren, müssen Entwickler diese Interaktionen in ihren Code einbauen. Die API-Dokumentation führt den Entwickler durch diesen Prozess. Es bietet auch Tipps zur Fehlerbehebung, Informationen zum Design der Benutzererfahrung und Anweisungen zur Lösung von Benutzerproblemen.

Da sie für Entwickler und Programmierer entwickelt wurde, ist die API-Dokumentation sehr technisch. API-Autoren sollten einen Hintergrund in Software oder Programmierung haben.

Prozessdokumentation

Die Prozessdokumentation ist eine Reihe detaillierter Schritt-für-Schritt-Anweisungen zur Ausführung einer Aufgabe. Sie unterscheidet sich von der Produktdokumentation, die beschreibt, wie ein technisches Element verwendet oder repariert wird. Stattdessen beschreibt die Prozessdokumentation Arbeitsabläufe. Hier sind ein paar Beispiele.

Dokumente zu Standardarbeitsanweisungen

Standard Operating Procedure (SOP)-Dokumente definieren die Erwartungen einer Organisation an einen bestimmten Prozess. Sie können auch als Standardarbeitsanweisungen, Geschäftsstandards oder Richtliniendokumente bezeichnet werden.

SOP-Dokumentation gibt es in mehreren Formen, darunter:

• Operations-Checklisten
• Bebilderte Anleitung
• Flussdiagramme
• Geskriptete Videos

Je technischer der Prozess, desto detaillierter wird das SOP-Dokument. Betrachten Sie dieses Dokument, das Sicherheitsverfahren für eine Drehmaschine in einer Maschinenwerkstatt einer Universität beschreibt:

Bevor Sie die Drehmaschine starten, vergewissern Sie sich, dass die Spindelarbeit die Bechermitte eingebettet hat [sic]; Heck-, Schaft- und Meißelauflagen sind sicher geklemmt; und es gibt einen angemessenen Freiraum für das rotierende Material. 4

Dokumente wie diese erfordern eine fundierte Kenntnis des Verfahrens. Der Autor kann dieses Wissen aus direkter Branchenerfahrung, Interaktionen mit Fachexperten oder praktischer Zeit mit dem Produkt gewinnen.

Geschäftsprozessskizzen

Diese Art der Prozessdokumentation kann weniger technisch sein, obwohl technisches Wissen erforderlich sein kann, je nachdem, worum es geht.

Beispielsweise kann ein Software-Startup eine Prozessdokumentation erstellen, um den Entwicklungsprozess zu organisieren. Das Dokument würde darlegen, was in jeder Phase passiert, von der Planung bis zur Veröffentlichung.

Testpläne sind eine gängige Art der Prozessdokumentation für Softwareentwickler. Sie erstellen einen schrittweisen Plan für das Testen von Software, einschließlich dessen, wer für welchen Schritt verantwortlich ist und welche Ausrüstung erforderlich ist.

Da es sich um interne Dokumente handelt, sind sie in der Regel sehr technisch, wie in diesem Beispiel eines Prototyps für die Kursanmeldung:

Der Zweck des Zusammenbaus des architektonischen Prototyps bestand darin, die Machbarkeit [sic] und die Leistung der ausgewählten Architektur zu testen. Es ist wichtig, dass alle System- und Subsystemschnittstellen sowie die Systemleistung in diesem frühen Stadium getestet werden. Tests der Systemfunktionalität und -merkmale werden nicht am Prototyp durchgeführt.5

Der Plan enthält auch Aufgabenbeschreibungen, Meilensteindaten und eine Liste der Ergebnisse.

Vertriebs- und Marketinginhalte

Unternehmen sind auf technische Redakteure angewiesen, um beim Verkauf ihrer Produkte zu helfen. Entwickler verstehen die Details der Funktionen und Fähigkeiten eines Produkts. Vertriebs- und Marketingteams müssen diese Merkmale auf ansprechende Weise kommunizieren.

Technische Redakteure können diese Lücke schließen. Sie können hochtechnische Produktdokumentationen einschließlich detaillierter Spezifikationen nehmen und sie für einen potenziellen Käufer relevant machen. Dies erfordert Kenntnisse der Best Practices im Vertrieb und ein Verständnis der beteiligten Technologie.

Kürzere Marketing-Assets wie Produktbeschreibungen sind normalerweise die Domäne des Texters. Aber wenn der Inhalt tiefer geht und detailliertere Beschreibungen der Produktfunktionen erfordert, braucht es einen Technischen Redakteur, um die Arbeit zu erledigen.

Weiße Papiere

White Papers sind ausführliche Berichte oder technische Artikel zu einem häufigen Schmerzpunkt oder Branchenproblem. Sie sind lehrreich und überzeugend und konzentrieren sich normalerweise auf die Produkte eines Unternehmens als bewährte Lösung für das Problem.

Unternehmen erstellen Whitepaper, um Fachwissen und Vordenkerrolle zu demonstrieren. Ein Whitepaper muss gründlich recherchiert und vollgepackt mit wertvollen Informationen sein, einschließlich Fakten und Statistiken, die über das Offensichtliche hinausgehen.

Die meisten Whitepaper-Leser sind mit der betreffenden Branche vertraut. Sie erwarten, dass das Material ihnen neue Einblicke in ein Problem bietet und tiefer geht als ein typischer Online-Artikel.

Erfahrene technische Redakteure können diese Tiefe bieten und gleichzeitig den Artikel lesbar und interessant halten. Ein technisches Whitepaper ist faktenreich, sollte den Leser aber dennoch mit einer zusammenhängenden Erzählung fesseln. Dieses Whitepaper erläutert beispielsweise die Vorteile einer neuen Technologie zur effizienten Fehlerbehebung von Software:

Da Prüfpunkte in C oder Java geschrieben sind, können Sie Prüfpunkte schreiben, um alles zu tun, was diese Sprachen tun können, einschließlich Aufrufen von Funktionen in Ihrer eigenen Anwendung, Aufrufen von Funktionen in Anwendungen von Drittanbietern oder gemeinsam genutzten Anwendungen – sogar das Untersuchen und Ändern der Register des Computers. Das bedeutet, dass Sie den Inhalt von Puffern untersuchen oder ändern, Eigenschaften abrufen und festlegen, Ausnahmen oder Fehlerbedingungen auslösen, Zeitstatistiken sammeln, Threads und Prozesse starten und so weiter können. 6

Das Schreiben eines solchen Whitepapers erfordert technisches Wissen und die Fähigkeit, dieses Wissen prägnant darzustellen. Sogar Technikexperten beschäftigen sich besser mit einer Geschichte als mit einer Liste technischer Spezifikationen. Ein gutes technisches Whitepaper leistet das.

Fallstudien

Fallstudien zeigen, wie das Produkt eines Unternehmens ein Problem gelöst oder ein Bedürfnis erfüllt hat. Sie erzählen die Geschichte der Reise eines Kunden von Anfang bis Ende, beginnend mit dem Schmerzpunkt, der ihn vor die Haustür des sponsernden Unternehmens brachte. Die Struktur umfasst:

• Eine Beschreibung des Problems
• Andere Lösungen, die der Client versucht hat, und warum sie nicht funktioniert haben
• Was brachte den Kunden zum Sponsoring-Unternehmen
• Wie das Unternehmen das Problem angegangen ist
• Messbare Ergebnisse
• Warum die Lösung funktioniert hat

Fallstudien richten sich an potenzielle Kunden mit ähnlichen Problemen. Wenn die Fallstudie gut geschrieben ist, hilft sie dem Leser zu sehen, wie er von den Produkten oder Dienstleistungen des Unternehmens profitieren könnte.

Wie Whitepaper brauchen Fallstudien Autoren, die die Branche, das Problem und die Lösung verstehen. Der Autor muss den Prozess verstehen und in der Lage sein, die wichtigen Punkte zu identifizieren, wie in diesem Beispiel:

Gleichzeitig mit der Anwendungsmigration entwarf und implementierte DPS eine Azure Cloud-Umgebung zum Hosten der Domänen-, Druck- und Dateiserver des Kunden. Obwohl diese Lösung in Azure war, hat DPS sie dennoch so konzipiert, dass sie geeignete Backups und Disaster-Recovery-Lösungen enthält. Der Wechsel zur Azure-Cloud verlief ebenfalls nahtlos, da die Azure-Umgebung erstellt und getestet wurde, während die Mitarbeiter ihr lokales System nutzten.7

Dieser hochtechnische Inhalt demonstriert den Wert des Dienstes prägnant und aussagekräftig. Der Leser tritt weg und vertraut auf das Fachwissen und die Fähigkeit des Sponsorunternehmens, sein Problem zu lösen.

Vorschläge und Aufforderungen zur Einreichung von Vorschlägen

Wenn ein Unternehmen ein anstehendes Projekt hat, hilft ihm der Vorschlagsprozess dabei, den richtigen Partner zu finden. Das Unternehmen, das das Projekt durchführt, erstellt eine Aufforderung zur Einreichung von Vorschlägen (RFP), in der das Projekt und sein Umfang beschrieben werden. In diesem Beispiel wird ein Auftragnehmer um eine Bewertung des Sicherheitsrisikos von Informationssystemen gebeten:

Es wird erwartet, dass eine Bewertung jährlich stattfindet, wobei die anfängliche Bewertung den gesamten SSP (18 Kontrollgruppen) abdeckt. Diese erste Bewertung wird die im ersten Quartal 2020 durchgeführten Penetrationstests verwenden. Nachfolgende jährliche Bewertungen werden eine identifizierte Teilmenge der im SSP enthaltenen Kontrollgruppen umfassen, damit eine vollständige Kontrollgruppenbewertung über einen Zeitraum von 3 Jahren abgeschlossen werden kann. Penetrationstests werden jährlich als Teil der laufenden Bewertungen durchgeführt. Dies ist ein bevorzugter Ansatz, wobei die Einreichung des Anbieters die vorgeschlagene Lösung angibt.8

Das Publikum für eine RFP ist sachkundig, daher kann das Dokument sehr technisch sein. Wenn sich ein Leser für eine Bewerbung qualifiziert fühlt, antwortet er auf die RFP mit detaillierten Vorschlägen. Zu den erfolgreichen Vorschlägen gehören:

• Pläne zur Erfüllung der Anforderungen des Anforderers
• Vorteile der Wahl des Anbieters
• Eine Liste der angebotenen Dienstleistungen und der entsprechenden Kosten

Der Vorschlag ist ein überzeugendes Dokument. Es muss das Vertrauen des potenziellen Kunden gewinnen und das vorschlagende Unternehmen als die bestmögliche Wahl präsentieren.

Häufig muss ein technisches Unternehmen seine Dienstleistungen einem Kunden in einer anderen Branche anbieten. Der Vorschlag muss Fachwissen demonstrieren, ohne den Leser einzuschüchtern oder zu verwirren. Ein Technischer Redakteur ist für diese anspruchsvolle Aufgabe in besonderer Weise qualifiziert.

Forschung und Berichte

Technische Redakteure arbeiten auch mit akademischen Forschern in Bereichen wie Wissenschaft, Technik und Medizin zusammen. Diese Fachleute sind Experten auf ihrem Gebiet, aber möglicherweise nicht in der Lage, ihr Wissen zu vermitteln.

Technische Redakteure sind Experten für die Synthese von komplexem Material auf hohem Niveau. Sie lesen sich die Ergebnisse der Forscher durch und verwenden das Gelernte, um klare informative Inhalte zu erstellen. Diese Inhalte können in wissenschaftlichen Zeitschriften erscheinen oder sich an ein allgemeineres Zielpublikum richten.

Beispielsweise berichten Hochschulen und Universitäten häufig über wichtige Lehrkräfte- oder Studentenforschungen. Technische Redakteure können diese Arbeit so beschreiben, dass Nicht-Tech-Leser sie verstehen, ohne sie zu verdummen oder die Wirkung beeindruckender Entdeckungen zu verlieren. Hier ist ein Beispiel für einen neuen Robotergreifer des Massachusetts Institute of Technology:

Der Greifer besteht aus zwei flexiblen Fin-Ray-Fingern, die sich der Form des Objekts anpassen, mit dem sie in Kontakt kommen. Die Finger selbst werden aus flexiblen Kunststoffmaterialien zusammengesetzt, die auf einem 3D-Drucker hergestellt werden, was in der Branche ziemlich üblich ist. Die Finger, die typischerweise in weichen Robotergreifern verwendet werden, haben jedoch unterstützende Querstreben, die durch die Länge ihres Inneren verlaufen, während Liu und Adelson den Innenbereich ausgehöhlt haben, um Platz für ihre Kamera und andere sensorische Komponenten zu schaffen.9

Autoren können Technologieunternehmen auch dabei helfen, ihre Arbeit einem Geschäftspublikum zu beschreiben. Technische Redakteure können diese Arbeit so kommunizieren, dass sie finanziert wird und Projekte auf dem Radar einer Führungskraft bleiben.

Die Bedeutung von qualitativ hochwertiger technischer Dokumentation

Technische Redakteure sind in der heutigen hypervernetzten Welt unverzichtbar. Sie bringen den Menschen bei, wie sie ihre Lieblingselektronik verwenden und machen Maschinen für ihr beabsichtigtes Publikum nutzbar.

Für Unternehmen sind Technische Redakteure unverzichtbare Vermittler zwischen Entwicklern und Publikum. Ihre technischen Schreibfähigkeiten geben den Benutzern Produkte und erhöhen die Benutzerfreundlichkeit jedes Produkts, wodurch es für Verbraucher und das Unternehmen wertvoller wird. Beachten Sie diese wichtigen Vorteile:

Zuverlässiger Anwendererfolg

Eine hochwertige Dokumentation hilft Benutzern, ihre Ziele zu erreichen, indem sie Verwirrung und die Notwendigkeit, um Hilfe zu bitten, reduziert. Anstatt Zeit damit zu verschwenden, herauszufinden, wie etwas funktioniert, kann der Benutzer seine Aufgabe schnell und genau erledigen. Benutzer fühlen sich erfolgreicher, was den Ruf des Produkts verbessert und die Marktfähigkeit verbessert.

Weniger kostspieliger technischer Support

Wenn Nutzer ein Produkt selbstständig bedienen können, verbringen sie weniger Zeit mit dem Hersteller oder Entwickler am Telefon. Das spart Geld auf beiden Seiten. Der Benutzer wird schneller fertig und das Unternehmen verliert weniger Support-Budget für die Fehlerbehebung. Dieses Geld kann stattdessen in die Innovation neuer Funktionen oder die Steigerung des Kundenerfolgs fließen.

Stärkere Sicherheitsaufzeichnungen

Die Produktdokumentation enthält häufig Sicherheitsempfehlungen und Warnungen. Sie helfen Fertigungs- und Lagerfachleuten, komplexe Maschinen sicher zu bedienen und die Wahrscheinlichkeit von Verletzungen zu verringern. Wenn diese Sicherheitswarnungen wirksam sind, reduzieren sie kostspielige Gerichtsverfahren und Schadensersatzansprüche der Arbeitnehmer.

Sicherheitswarnungen helfen auch Verbraucherunternehmen, Klagen und schlechte Presse zu vermeiden. Hier ist ein Beispiel für eine Verbraucherwarnung aus der Bedienungsanleitung des RAV4 Prime 2021:

Betätigen Sie die elektrischen Fensterheber oder das Schiebedach oder das Panorama-Schiebedach, nachdem Sie sich vergewissert haben, dass keine Möglichkeit besteht, dass ein Insasse mit Körperteilen im Fenster oder im Schiebedach oder Panorama-Schiebedach eingeklemmt wird. Erlauben Sie Kindern auch nicht, den mechanischen Schlüssel zu bedienen. Es besteht die Möglichkeit, dass sich Kinder und andere Insassen im elektrischen Fensterheber oder Schiebedach oder Panorama-Schiebedach verfangen.10

Warnungen wie diese schützen Familien.

Größeres Publikum und bessere Verkäufe

Sie wissen, dass Ihr Produkt das Leben der Benutzer verändern kann. Technische Redakteure vermitteln diese Botschaft mit maximaler Wirkung und helfen Ihnen, mehr Kunden zu erreichen.

Neue Ideen realisiert

Investoren und Führungskräfte finanzieren keine technischen Spezifikationen. Sie finanzieren Benutzervorteile, die zum Kauf anregen. Technische Redakteure können Projekte so beschreiben, dass sie bei nicht-technischen Zielgruppen Anklang finden, und Entwicklern helfen, Finanzmittel zu erhalten.

Komplexe Technologie vereinfacht

Unabhängig vom Projekt nehmen technische Redakteure der Technologie das Geheimnis. Sie wühlen sich durch Spezifikationen und Berichte und ziehen die Informationen heraus, die für Käufer und Geldgeber wichtig sind. Indem sie diese Informationen auf eine für die Leser verständliche Weise kommunizieren, sorgen technische Redakteure dafür, dass sich Produkte zugänglicher anfühlen, und stärken die Kundenbindung.

Die Suche nach den besten Technischen Redakteuren

Ein qualifizierter Technischer Redakteur ist Gold wert, aber nicht immer leicht zu finden. Unternehmen können Stunden damit verbringen, über Lebensläufe für interne Positionen zu brüten oder die Portfolios von Freiberuflern zu überprüfen. Diese Zeit wird viel besser genutzt, um innovative Produkte voranzutreiben oder Verkäufe zu tätigen.

Verbringen Sie keine weitere Minute mit der Suche nach dem perfekten Autor. Compose.ly bietet vorab geprüfte technische Redakteure, die speziell auf Ihr Projekt abgestimmt sind, damit Sie ohne Stress die beste Lösung finden. Sie erhalten hochwertige Inhalte ohne logistischen Aufwand, damit Sie sich auf Ihr Geschäft konzentrieren können.