Technisches Schreiben ist die Praxis der Verarbeitung von Dokumenten und Bildern, verbalen Informationen und Demonstrationen zu Schulungsmaterial. Der Zweck des technischen Schreibens besteht darin, Material bereitzustellen, das einen Prozess erklärt oder ein komplexes Konzept für ein bestimmtes Publikum verständlicher macht. Durch effizientes und effektives technisches Schreiben kann der Autor dem Leser erklären und helfen, Informationen zu verstehen und bestimmte Aufgaben zu erfüllen. Es gibt fünf universelle ethische Prinzipien des technischen Schreibens. Die Prinzipien sind Qualitätsinhalt, Publikum und Zweck, Zugänglichkeit, Grammatik und Schreibstil.
Qualitätsinhalt
Qualitätsinhalt ist subjektiv. MATCS Definition von qualitativ hochwertigen Inhalten ist ein Produkt, das den Standards eines Kunden entspricht oder über den ursprünglichen Umfang des Projekts hinausgeht. Um ein qualitativ hochwertiges Projekt zu erstellen, müssen Sie mit Blick auf die Zielgruppe schreiben. Der Verfasser muss zusätzliche Kenntnisse recherchieren, die erforderlich sind, bevor das Dokument oder Material fertiggestellt wird. Der Verfasser muss wissen, welches Format oder welche Plattform zur Darstellung der Informationen verwendet wird. Der Verfasser muss bestimmte Informationen ermitteln, die von der Kenntnis der Fristen bis zur Kenntnis der Gründe für das Schreiben der Informationen reichen.
Publikum und Zweck
Der Autor muss sowohl Zweck als auch Publikum verstehen, um ein herausragendes technisches Stück zu schaffen. Das Publikum des technischen Schreibens variiert je nach Branche und Kunde. Zum Beispiel wäre das Publikum eines Lap-Berichts der Produkthersteller, der uns als Autoren eingestellt hat. Das Publikum für ein eLearning-Trainingsmodul kann eine Bank oder ein Hypothekenanbieter sein, der Compliance-Schulungen benötigt. Der Autor muss wissen, wie viel die Leser wissen und welche Verantwortlichkeiten der Autor erfüllen muss, wenn es um die Kommunikation mit den Lesern geht.
Zugänglichkeit
Es ist wichtig, dass das Publikum problemlos auf die vom Autor erstellten Informationen zugreifen kann. Barrierefreiheit umfasst alles, was sich in einem Dokument befindet, z. B. Kopf- und Fußzeilen, oder auf Computer-iLearn-Modulen, die die Formatierung der Barrierefreiheit verbessern, um universeller und klarer zu sein. Der technische Redakteur muss die beste Methode finden, um den Lesern das Navigieren in der Dokumentation mit Notationen von einer Bibliographie über Seitenzahlen bis hin zu einem Inhaltsverzeichnis zu erleichtern. Der Verfasser könnte sogar Visualisierungen wie Diagramme und Abbildungen hinzufügen, um Informationen weiter zu erklären.
Grammatik
Beim Schreiben eines technischen Artikels ist es wichtig, klar, prägnant und unkompliziert mit der richtigen Grammatik zu schreiben. Der Verfasser muss auch jedes technische Stück, das geschrieben wird, Korrektur lesen und bearbeiten, um Fehler oder Inkonsistenzen mit Grammatik, Stil und Layout zu korrigieren. Ein technischer Redakteur sollte immer in der Gegenwart schreiben, es sei denn, der Kunde gibt seine Präferenz anders an. Der Leser des technischen Artikels sollte genau das tun, wofür Sie Anweisungen geben. Der Autor sollte immer in einfachen Sätzen schreiben, die geschlechtsneutrale Substantive enthalten. Einfache Sätze helfen den Lesern, die Aufgaben, die sie erledigen müssen, um ihre Ziele zu erreichen, klar und effizient zu verstehen.
Schreibstil
Der Schreibstil unterscheidet sich für jedes technische Stück, da es stark davon abhängt, wer das Publikum ist und für welches Szenario das technische Stück geschrieben wird. Der Ton eines technischen Schreibens ist wichtig, weil es dem Leser hilft zu verstehen, welche Art von Ton erforderlich ist, um die Aufgabe zu erledigen. Die Wortwahl ist auch ein wesentlicher Bestandteil des Stils, um die Bedürfnisse des Publikums zu erfüllen, da sie eine Verbindung zu Ihrem Publikum herstellt. Wenn Sie auf Abschnitte von Informationen oder Websites verweisen, ist es wichtig, klare und sichtbare Möglichkeiten für den Zugriff auf die Informationen mithilfe von Tools wie Abbildungen und Tabellen bereitzustellen.
Weitere Tipps zum technischen Schreiben
Recherchieren Sie zusätzlich und erfahren Sie mehr
Wenn Sie das absolute Minimum kennen, erhalten Sie möglicherweise nicht das beste technische Stück, um dem Publikum das Verständnis der Informationen zu erleichtern. Es könnte eine Menge Terminologie geben, die sowohl der Autor als auch der Leser möglicherweise nicht verstehen. Als Faustregel gilt: Wenn Sie als Leser ein Konzept oder einen Begriff nicht verstehen, definieren Sie es. Zu viele Informationen können in späteren Bewertungen immer reduziert werden. Diese Informationen sollten recherchiert werden, um zu verstehen, wie sie mit dem funktionieren, was der Autor als Ganzes schreibt. Recherchieren Sie ein wenig und finden Sie heraus, welche anderen Informationen verwendet werden könnten, um das zu schreibende technische Stück zu verbessern.
Werden Sie zum Publikum und unterschätzen Sie das Publikum
Versetzen Sie sich in die Lage des Publikums. Können Sie die Anweisungen oder Informationen, die Sie für das Publikum geschrieben haben, klar verstehen und befolgen? Wenn ja, können Sie weitere Informationen bereitstellen, wenn Sie der Meinung sind, dass etwas mehr Hilfe erforderlich ist. Wenn nicht, müssen Sie die Teile finden, die nicht klar sind, und einen Weg finden, die Informationen ordnungsgemäß bereitzustellen. Ein großes Problem, das technische Redakteure oft haben, ist, dass sie das Wissen ihres Publikums überschätzen. Das Publikum könnte mehrere Personen mit unterschiedlichem Wissensstand sein. Es ist durchaus akzeptabel, kurz Informationen bereitzustellen, die als Auffrischung für das Publikum angenommen oder bereits angegeben werden könnten.
Fragen Sie nach einer zweiten und dritten Meinung und Peer Review
Technische Redakteure sind einfallsreich. Die größte Ressource, die Sie haben, sind Ihre Fachexperten. Stellen Sie sicher, dass Sie Ihr KMU fragen, ob es Wissenslücken oder Fehler sieht. Autoren erkundigen sich bei ihren Kunden, ob es Wissenslücken oder Fehler gibt, die der Autor übersehen könnte. Wenn ein Vorgesetzter oder Kollege vorbeischaut und eine Meinung abgibt, kann dies auch dazu beitragen, ein technisches Stück zu verbessern. Peer Review ist, wenn sich eine Gruppe von Menschen trifft, um die Arbeit des anderen zu lesen, zu kommentieren und Verbesserungen zu empfehlen. Mehr blinde Flecken werden aufgedeckt, wenn mehr Menschen ein Dokument überprüfen, was genaue und präzise Informationen gewährleistet.
Technische Redakteure lernen für jedes Projekt, an dem sie arbeiten, neue Informationen. Die Autoren erhalten ein besseres Verständnis dafür, was Kunden benötigen, da sie vor allen Recherchen und Diskussionen mit den Fachexperten unterhalb des Wissensniveaus ihrer Leser beginnen. Dies wird zu einem großen Vorteil für Unternehmen, da weniger Annahmen für effektivere Schulungen offen stehen. Die Kombination der Autoren, die das Material lernen, und diese ethischen Prinzipien der technischen Schreibstandards führen zu selbstbewussteren und effizienteren Mitarbeitern.