Wichtige Hinweise zur Erstellung Technischer Dokumentationen

(openPR) Eigentlich kann (fast) jeder schreiben. Bei Anleitungen und technischen Dokumentationen kommt es jedoch darauf an, Sprache zweck- und zielgruppengerecht einzusetzen.
Die KONTECXT GmbH hat daher die wichtigsten Anforderungen zur Sprache und zu den Formulierungen in Anleitungen zusammengetragen:


Eine ausführlichere Beschreibung mit einfachen Beispielen finden Sie im News-Bereich der
KONTECXT GmbH - Technische Dokumentation unter http://www.technische-dokumentation.de/news/news.html.

• Landessprachen
Bei der Auswahl der zu liefernden Landessprachen müssen die jeweiligen Zielgruppen berücksichtigt werden.
• Fachbegriffe
Der Zielgruppe möglicherweise nicht bekannte Fachbegriffe und Abkürzungen müssen so weit wie möglich vermieden werden. Unvermeidliche Fachbegriffe müssen beim ersten Auftauchen erklärt werden.
• Bezeichnungen
Gleiches muss immer gleich bezeichnet werden, nicht nur in der Anleitung, sondern auch auf der Verpackung.
• Handlungsanweisungen
Ein Satz darf bis auf wenige Ausnahmen nur eine Handlungsanweisung beinhalten.
• Formulierungen
Formulierungen in Anleitungen müssen möglichst klar, eindeutig und direkt sein.
• Verwendung von Verben
In Anleitungen sollen Verben im Aktiv und nicht im Passiv verwendet werden.
• Substantivierungen
Substantivierungen von Tätigkeiten müssen vermieden werden.
• Standardisierung
Soweit sinnvoll sollen standardisierte Formulierungen verwendet werden.
• Formulieren von Warnhinweisen
Texte von Warnhinweisen müssen auf das Wesentliche beschränkt werden.
Warnbegriffe müssen in Anleitungen, auf dem Produkt und in weiteren Begleitmaterialien konsistent verwendet werden.

Wer diese Hinweise beim Verfassen von Anleitungstexten beachtet, hat eine sehr gute Grundlage für verständliche Anleitungen und Dokumentationen geschaffen.