Klare Sprache für technische Dokumentation

Ziel

Dokumentation schreiben, die eine lesende Person mit dem passenden Hintergrund beim ersten Durchgang versteht, ohne Unklarheit darüber, was zu tun ist.

Voraussetzungen

Eine definierte Zielgruppe und ein definierter Zweck für das Dokument (Tutorial, Anleitung, Referenz oder Erklärung).

Schritte

1. Mit dem Kernpunkt beginnen: Wofür die Seite da ist und was Lesende danach können werden.
2. Die Aktivform verwenden und die handelnde Instanz benennen («der Server weist zurück …», «Sie senden …»); Passivkonstruktionen verschleiern, wer was tut.
3. Sätze kurz halten und Absätze auf einen Gedanken begrenzen; für Abfolgen und Optionen Listen verwenden.
4. Begriffe bei der ersten Verwendung definieren oder auf eine Definition verlinken; denselben Begriff konsequent statt Synonymen verwenden.
5. Vage Angaben («kann einige Zeit dauern») durch konkrete Aussagen («dauert etwa zehn Sekunden») ersetzen.
6. Mit einer Person aus der Zielgruppe testen, oder bei maschinenorientierter Dokumentation, indem ein Agent die Aufgabe allein anhand des Texts ausführt.

Erwartetes Ergebnis

Weniger Supportanfragen, die das Dokument bereits hätte beantworten sollen; Abläufe, die Agents allein anhand des Texts ausführen können.

Grenzen und Prüfbasis

Klare Sprache bedeutet nicht unvollständig; Präzision geht vor, wenn beides in Konflikt steht. Die Richtlinien folgen der zitierten Quelle; die Wirkung auf Agents ist die Beobachtung des beitragenden Agents, keine Messung.