Schreibregeln für die Technische Dokumentation

Wörter und Sätze können mehrdeutig sein. Sie sollten es sogar sein - in der schönen Literatur. In der technischen Dokumentation führt Mehrdeutigkeit zu Verwirrung.

Hier sind klare Strukturierung und eindeutige Aussagen unerlässlich. Technische Dokumentation soll den LeserInnen schnell relevante und eindeutige Informationen liefern. Die folgenden Tipps sollen helfen, dieses Ziel zu erreichen:

1. Gliedern Sie die Informationen in logische und überschaubare Einheiten.
2. Erfassen Sie die eventuell vorgegebene Terminologie in einer Tabelle oder Datenbank.
   (Terminologie kann durch Kundenwünsche, Programmoberfläche u.a. vorgegeben sein.)
3. Ergänzen Sie die Terminologie um Begriffe, die häufig auftauchen. Diese Arbeit sollten Sie während des Schreibens fortführen. Benutzen Sie immer dieselben Wörter für einen bestimmten Vorgang, eine bestimmte Funktion usw.
   Hinweis: Wenn Sie von Anfang an eine Terminologieliste führen, haben Sie bereits eine gute Voraussetzung für möglicherweise später anfallende Übersetzungen geschaffen.
4. Versehen Sie die Abschnitte mit aussagekräftigen Überschriften, damit LeserInnen schon im Inhaltsverzeichnis sehen, welche Informationen sie wo finden.
5. Schreiben Sie pro Absatz eine wichtige Kernaussage mit Erläuterung.
6. Verzichten Sie auf Füllwörter und nichts sagende Phrasen.
7. Verzichten Sie so weit als möglich auf Fremdwörter. Die eigene Sprache ist immer noch die verständlichste.
8. Denken Sie daran, dass Ihr Lesepublikum nicht nur aus Männern besteht. Verwenden Sie deshalb geschlechtsneutrale Substantive, z.B. Systemadministration.
9. Schreiben Sie kurze Sätze.
10. Sätze im Aktiv sind kürzer und sind schneller zu lesen als Sätze im Passiv.
11. Umständliche Formulierungen vermeiden Sie durch direkte Ansprache der LeserInnen.
12. Markieren Sie unterschiedliche Informationen, z.B.
    Schrittanleitung als nummerierte Liste
    Hinweise mit einem entsprechenden Symbol
    Warnungen mit einem Symbol oder Textrahmen usw.
13. Erstellen Sie einen Index mit den zentralen Begriffen, und überlegen Sie dabei, wie Sie als LeserIn nach einer bestimmten Information suchen würden. Nehmen Sie auch alternative Suchbegriffe im Index auf, evtl. mit Querverweis z.B. Plattform:siehe Betriebssystem.
    

---

03.08.05
Eva Fitz - Redaktionsleiterin bei Comet Computer
Weitere Artikel von Eva Fitz