Grundprinzipien des technischen Schreibens

Hin und wieder müssen wir die Grundprinzipien des technischen Schreibens überdenken. Seit wir 1997 angefangen haben, sind die Grundprinzipien des technischen Schreibens gleich geblieben, auch wenn sich die Kommunikationsmodi ändern.

Zweck und Zielgruppe

Vor Beginn eines neuen Schreibprojekts muss ein technischer Redakteur den Zweck des Dokuments analysieren und seine Zielgruppe identifizieren. Der Autor muss fragen:

• Wer liest die Dokumentation?
• Was sind ihre Vorurteile?
• Welche Verantwortung habe ich, wenn ich Informationen an das Publikum kommuniziere?

Styleguide

Technische Redakteure verwenden häufig einen Unternehmens-Styleguide, falls verfügbar, um sicherzustellen, dass ihre Dokumentation ein strukturiertes Muster aufweist. Ein Styleguide (z. B. das AP Stylebook) enthält Richtlinien für das Aussehen eines Dokuments, die verwendete Sprache und die Anordnung von Ideen. Diese Organisation verleiht einem Dokument oder einer Reihe von Dokumenten Kontinuität, sodass das Publikum die Informationen leicht verstehen kann. Beispielsweise kann ein technischer Redakteur einen Prozess chronologisch dokumentieren, wie im Styleguide vorgeschrieben. Ohne diese Struktur wäre der Leser verwirrt und nicht in der Lage, den Prozess zu verfolgen. Styleguides machen das Schreiben konsistenter und lesbarer.

Schreibstil

Technische Redakteure ändern ihren Schreibstil je nach Publikum und der Situation, über die sie schreiben. Wenn sie technische Dokumentation schreiben, sollte der Stil formal sein, ohne die Emotionen, die Sie beim kreativen Schreiben bekommen. Wenn sie eine E-Mail an einen der am Projekt beteiligten Senior Manager schreiben, wäre ihr Stil gesprächiger.

Zugriff auf die Informationen

Barrierefreiheit gibt an, wie leicht die Informationen in einem Dokument von der Zielgruppe abgerufen werden können. Ein technisches Dokument enthält Elemente wie ein Inhaltsverzeichnis, Kopf- und Fußzeilen sowie Seitenzahlen, um die Leser beim Navigieren im Dokument und beim Auffinden der benötigten Informationen zu unterstützen. Ein technisches Dokument hält sich auch an eine bestimmte Struktur von Überschriften und Unterüberschriften, um die Informationen in relevante Abschnitte zu unterteilen, auf die der Leser leicht zugreifen kann.

Dies sind nur einige der Aspekte, die wir als technische Redakteure ansprechen. Wenn Sie Ihre eigenen technischen Schreibfähigkeiten verbessern möchten, sollten Sie unseren Workshop für technisches Schreiben in Betracht ziehen. Es kann angepasst werden, um die bedürfnisse von 1 person oder 20 menschen!

Wenn Sie das Dokument nicht selbst schreiben möchten und Hilfe von einem erfahrenen technischen Redakteur benötigen, besuchen Sie unsere Serviceseite.

Wir sind hier um zu helfen. Kontaktieren Sie uns noch heute!