Wenn ich Software-Dokumentationen oder Konzepte lese, bekomme ich oft das Gefühl, dass mir einige Informationen fehlen, um das Geschriebene in die Tat umzusetzen. Ich spüre das Beamtendeutsch in den einzelnen Sätzen. Ich weiß nicht, ob eine beschriebene Aktion eine ist, die ich ausführen sollte oder sie eine ist, die automatisch, unabhängig von mir, geschieht. Leute denken leider viel zu oft, dass es sich gut anhört, wenn man möglichst unverbindlich schreibt, was "geschehen soll".
Dabei gibt einen ganz einfachen Trick einen Text so zu schreiben, dass jeder weiß, wann man Aktivitäten als Leser ausführen muss und wann nicht.
"Gute Software-Dokumentationen oder Konzepte" vollständig lesen »
Andere Kommentare