Prinzipien des Technischen Schreibens

Eine gut geschriebene und genaue Dokumentation ist Teil der Kundensupportstrategie und senkt die Supportkosten. Technisches Schreiben ist viel mehr als Fachjargon und prägnante Anleitungen. Unser Publikum besteht aus Menschen und nicht nur aus technischem Personal. Technisches Schreiben erfordert, dass der Autor einen Hauptpunkt oder eine These präsentiert, den Fokus behält, Ideen organisiert und entwickelt und den angemessenen Stil für das Publikum verwendet. Im Folgenden sind die Grundprinzipien des Technischen Schreibens aufgeführt.

Inhalt

Fünf grundlegende Fragen – wer, warum, was, wie und wann – werden in verschiedenen Situationen angewendet, um den Inhalt für jede Art von Dokument zu entwickeln. Stellen Sie sich zum Beispiel eine Situation vor, in der Sie einen Bericht basierend auf Ihrer Bilanz erstellen müssen. Bevor Sie einen Bericht erstellen, können Sie den Inhalt Ihres Berichts planen, indem Sie die folgenden Schlüsselfragen auf die Situation anwenden:

o Wer möchte den Bericht lesen?

o Warum wollen/müssen Sie einen Bericht vorlegen?

o Was wird dieser Bericht dem Publikum präsentieren?

o Wie wird der Bericht präsentiert?

o Wann wird der Bericht vorgelegt?

Die Schreibsituation: Zielgruppe und Zweck

Vor Beginn einer Schreibaufgabe analysiert der Autor das Publikum und identifiziert den Zweck des Dokuments. Der Autor stellt dem Publikum folgende Fragen:

o Wer liest das Dokument?

o Was sind ihre Vorurteile?

o Welche ethische Verantwortung haben technische Redakteure, wenn sie dies dem Publikum mitteilen?

Hinsichtlich des Zwecks fragen Technische Redakteure: Was soll dieses Dokument leisten? Was soll es tun? Sollte es:

o Informieren

o Anfrage

o Instruieren

o vorschlagen

o Bestellen

o Bericht

o Antworten

o Analyse/Kritik

o Vergleichen

• Organisation

Autoren verwenden ein Organisationsmuster, um dem Schreiben Konsistenz zu verleihen. Organisationsmuster verleihen dem Dokument Kontinuität, sodass das Publikum die Ideen verstehen kann. Zum Beispiel können Schriftsteller ihre Ideen chronologisch, räumlich und kategorisch ordnen.

• Stil

Autoren ändern ihren Stil je nach Publikum. Eine Person würde eine E-Mail an einen engen Freund nicht im gleichen Stil schreiben wie ein formelles Memorandum an einen Manager. Autoren wenden je nach Schreibsituation entweder formelle oder informelle Stile an.

• Zugänglichkeit und Spezifität

Zugänglichkeit bezieht sich auf die Leichtigkeit, mit der das Publikum die benötigten Informationen aus einem Dokument gewinnen kann. Inhaltsverzeichnis, Kopfzeilen, Fußzeilen, Seitenzahlen, Überschriften und Unterüberschriften tragen dazu bei, das Dokument für das beabsichtigte Publikum zugänglicher zu machen.

• Konventionelle Grammatik und Mechanik

Autoren halten sich an die Regeln der konventionellen Grammatik und Mechanik. Technische Redakteure lesen und bearbeiten das Dokument im Wesentlichen, um Fehler in Grafik, Typografie und Layout zu erkennen und zu korrigieren.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.