Die Herausforderung bei der Erstellung von technischen Dokumentationen liegt darin, sowohl fachspezifisch korrekt als auch allgemein verständlich zu sein. Häufig werden technische Dokumentationen von Ingenieuren und Technikern geschrieben, die das Produkt oder die Software gut kennen, aber nicht unbedingt die Kenntnisse und Fähigkeiten haben, die Informationen auch für Laien verständlich aufzubereiten. Technische Dokumentation ist ein weites Feld.

Zu den häufigsten Arten gehören Bedienungsanleitungen, Installationsanleitungen, Wartungsanleitungen, Diagnoseanleitungen und Schulungsunterlagen.

Lösung: 1. Schritt: Identifizieren Sie Ihr Publikum Bevor Sie mit dem Schreiben beginnen, sollten Sie sich zunächst überlegen, für wen Sie die technische Dokumentation erstellen. Je besser Sie Ihr Publikum kennen, desto einfacher ist es, die richtigen Wörter und Beispiele zu finden, um Ihre Botschaft rüberzubringen. Machen Sie sich außerdem Gedanken darüber, was Ihr Publikum über das Thema bereits weiß und wo seine Schwierigkeiten liegen könnten.

2. Schritt: Strukturieren Sie Ihren Inhalt Gute technische Dokumentation ist logisch aufgebaut und leicht zu navigieren. Beginnen Sie mit einem Inhaltsverzeichnis und legen Sie fest, welche Informationen in jedem Abschnitt enthalten sein sollten. Achten Sie darauf, dass jeder Abschnitt einen klaren Zweck hat und nicht zu viele Informationen enthält. Wenn möglich, sollten Sie den Inhalt auch visualisieren, zum Beispiel mit Grafiken oder Tabellen.

3. Schritt: Verwenden Sie einfache Sprache Technische Begriffe können für Laien schwer verständlich sein. Verwenden Sie also einfache Sprache und erklären Sie Fremdwörter, wenn nötig. Zusammengesetzte Wörter sollten möglichst vermieden werden – statt „Durchführbarkeitsanalyse“ schreibt man besser „Untersuchung der Machbarkeit“ oder „Analyse der Umsetzbarkeit“. Auch Satzzeichen können helfen, den Text leichter verständlich zu machen: Setzen Sie Ausrufe- oder andere Zeichen am Ende eines Satzes oder verwenden Sie Abschnitte, um verschiedene Themen voneinander abzugrenzen.

Werbung