Knigge für Softwarearchitekten: Die Lektorin

Aktiv statt passiv

„Tritt dieses Ereignis ein, müssen alle Testdaten angepasst werden“. Wer soll die Daten anpassen? Ein Programm? Ein Programmierer? Ein Tester?

Bringen Sie durch aktive Formulierungen zum Ausdruck, wer „der Täter“ [1] ist. Erstens hilft es beim Verständnis und zweitens entstehen viel interessantere Sätze. Passive Konstruktionen wirken oft langweilig.

Lesermeinung zählt

Holen Sie aktiv die Rückmeldung Ihrer Leser ein: Stellen Sie denen die Frage nach Einfachheit und Verständlichkeit: Falls die Ihnen nach Lektüre Ihrer Dokumente zu viele Verständnisfragen stellen, müssen Sie vereinfachen oder kürzen. Lesermeinung zählt mehr – denn Leser müssen die Texte verstehen.

Verständlich statt bombastisch

Im Vorwort von [1] schreibt Herr Rechenberg, dass „in der deutschsprachigen Informatik-Literatur inhaltliche und darstellerische Qualität oft auseinanderklaffen“. Wir Informatiker schaffen es, brilliante Inhalte in sprachliches Ungenügend zu verpacken. Wir formulieren bombastisch, unverständlich und verworren an den Bedürfnissen unserer Leserschaft vorbei. Übermäßig komplizierte und gestelzte Formulierungen fungieren als Ersatz für Fachkompetenz und Klarheit.

Bitte, liebe Architektinnen und Architekten: Gehen Sie mit gutem Beispiel voran. Schreiben Sie technische Literatur („Architekturdokumentation“) einfach, klar, verständlich und kompakt. Vielschreibern empfehlen wir dringend und inständig die Bücher [1], [2] und [4] aus der Literaturliste!

Der Ton macht die Musik

Klare, einfache, positive Sprache ohne Schnörkel hilft Ihnen auch in der mündlichen Kommunikation weiter – obwohl dabei noch die zusätzlichen Herausforderungen der Rhetorik auf Sie zukommen. Der klarste Satz und die treffendste Formulierung gehen verloren, wenn Sie Ihrem Gesprächspartner damit verbal „auf die Füße treten“…, aber das geht über die Aufgaben einer Lektorin weit hinaus.

Ach ja: Wie bei so vielen Dingen macht auch beim Schreiben nur die Übung den Meister. Viel sprachlichen Erfolg!

Jetzt bestellen auf entwickler.press!

Kurzinfo:

Verantwortungsbewusste Softwarearchitekten versuchen kontinuierlich, Chancen und Risiken frühzeitig zu erkennen und geeignete Maßnahmen einzuleiten. Dieses Buch zeigt Ihnen, wie das in der Praxis funktioniert.

Sie finden unterhaltsame, praxisgerechte Wege zu besseren Softwarearchitekturen – wirkungsvoll, zeitlos und technologieneutral! Wir erläutern typische Verhaltensmuster von Softwarearchitekten, gute und schlechte. Sie lernen, durch Erfolgsmuster bessere Systeme zu konstruieren und erfahren Abhilfen gegen schlechte Architekturmanieren (Anti-Patterns).

Aus dem Inhalt:

Auf entwickler.press steht für Sie ein exklusives Probekapitel zum Download bereit!

Kommentare

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.