16 - Die Lektorin - Knigge für Softwarearchitekten

Dies ist ein (unvollständiger) Auszug aus dem gedruckten Buch .

Da die Schriftsprache immer noch ein bevorzugte Mittel langfristiger menschlicher Kommunikation und Dokumentation bildet, sollten Sie als Architekt einige Grundregeln dazu beherzigen.

Nehmen Sie Sprache ernst

Legen Sie großen Wert auf verständliche, klare und einfache Sprache. Sie schreiben für Ihre Leser und Leserinnen, nicht zum Selbstzweck. Das alles halten Sie für selbstverständlich? Wir auch.

Warum wirkt dann ein signifikanter Teil der uns bekannten technischen Dokumentation wie eine Mischung aus Schlaftablette und Streckbank (sprich: macht müde und tut weh!)?

Weil die Grundregeln guter Sprache eben doch nicht selbstverständlich sind.

Wir haben für Sie kräftig in den großartigen Büchern von Peter Rechenberg¹ und Wolf Schneider² gelesen und einige Ratschläge daraus zusammengestellt.

Schaffen Sie Klarheit – in Kürze

Kurze Texte machen Ihren Lesern weniger Arbeit – Grund genug, auf Füllstoff möglichst zu verzichten. Wenn Sie Ihre Gedanken möglichst klar ausdrücken möchten, hilft eine kurze Erklärung statt einer langen. Verzichten Sie in technischer Dokumentation auf Spannungsbögen und blumige Umschreibung.

Klarheit bedeutet auch, treffende Worte zu finden. In der Programmierung kennen wir alle die Notwendigkeit „sprechender Bezeichner“ – Gleiches gilt für Ihre schriftliche Kommunikation. Besonders warnen wir Sie vor missverständlichen oder mehrfach belegten Wörtern – etwa Komponente, System, Anwendung oder Funktionalität. Solche Begriffe haben in verschiedenen Kontexten unterschiedliche Bedeutung. Suchen Sie nach exakten, genau zutreffenden Wörtern.

Schreiben Sie einfach

Mit Kürze und Klarheit ist Einfachheit eng verbunden, erläutert Rechenberg¹:

„Einen Sachverhalt klar und kurz beschreiben heißt auch, ihn so einfach wie möglich beschreiben, mit einfachen Worten und einfach gebauten, unverschachtelten Sätzen.“

In Gesetzestexten oder amtlichen Verordnungen können Sie selbst leidvoll erfahren, wie außerordentlich lang und kompliziert Sätze der deutschen Sprache sein können. Ein Satz soll einen Gedanken ausdrücken, den Sie sich am besten VOR dem Schreiben schon gemacht haben. Übermäßig lange Sätze mit geschachtelten Nebensätzen wirken oft kompliziert und deuten auf schlechte Verständlichkeit hin.

Positiv formulieren

Wir möchten zur allgemeinen Erheiterung aus dem Paragraph 181 des Bürgerlichen Gesetzbuch³ (BGB) der Bundesrepublik Deutschland zitieren – ein anschauliches Plädoyer für positive Formulierung:

„Paragraph 181 – Mangel der Ernstlichkeit: Eine nicht ernstlich gemeinte Willenserklärung, die in der Erwartung abgegeben wird, der Mangel der Ernstlichkeit werde nicht verkannt werden, ist nichtig.“³

(Hervorhebungen von uns)

Solche Formulierungen sind grausam: Das menschliche Gehirn benötigt für das Verständnis negativer Aussagen etwa 50 % länger als für positive: Positive Formulierungen sind deutlich verständlicher.

Aktiv statt passiv

„Tritt dieses Ereignis ein, müssen alle Testdaten angepasst werden“.

Wer bitte soll die Daten anpassen? Ein Programm? Ein Programmierer? Ein Tester? Erledigt die dunkle Macht das für uns?

Bringen Sie durch aktive Formulierungen zum Ausdruck, wer aktiv ist. Erstens hilft es beim Verständnis und zweitens entstehen viel interessantere Sätze.

Passive Konstruktionen wirken oft langweilig.

Hinweis

arc42 offers architecture training.

The data is currently loaded from the backend and should display here shortly. If not, you can see the next dates at trainings.arc42.org .

Peter Rechenberg: Technisches Schreiben (nicht nur) für Informatiker, 3. Auflage, Carl Hanser Verlag, 2006 ↩ ↩²
Wolf Schneider: Deutsch für Profis. Wege zu gutem Stil, Goldmannn, 2001 ↩
Bürgerliches Gesetzbuch, Paragraph 181. Zitiert nach Wolf Schneider sowie http://dejure.org/gesetze/BGB/118.html. Tragisch: Diese Formulierung ist deutsches Gesetz! ↩ ↩²

16 - Die Lektorin