Auch Code ist ein Mittel der Verständigung

Heute mal ein kurzer, aber meines Erachtens wichtiger Tipp für meine Leser aus der IT-Branche: Denkt dran, dass auch Code ein Mittel der Verständigung ist und überlegt wie ihr eure Botschaft möglichst gut an den Mann oder die Frau bringt. Das gilt nicht nur für die Softwarentwicklung sondern beispielsweise auch für Infrastructure as Code.

Warum?

Ganz einfach deshalb, weil der meiste Code letztlich mehrfach und von unterschiedlichen Personen gelesen wird.

Das können Teamkollegen sein, die euren Code in einem Review überprüfen sollen, um durch das Vier-Augen-Prinzip bessere Qualität und Wissensverteilung zu erreichen, aber auch Auditoren und später neue Teammitglieder bei der Einarbeitung. Im Falle von Infrastructure as Code können es sogar Kunden sein.

Wie kann man das berücksichtigen?

Wie auch bei Schriftstücken hilft es, wenn man sich bewusst macht, dass der Code meist in einem anderen Kontext und von Personen gelesen wird, die ein anderes Bündel an Wissen und Erfahrung als ihr haben.

Der Trick besteht darin, diesen Personen entgegen zu kommen, indem man die eigene Absicht möglichst klar vermittelt. Dabei helfen ausgeschriebene und eindeutige Bezeichnungen und Kommentare, die das „Warum“ vermitteln. Aber auch die Art der Umsetzung zu suchen, die möglichst verständlich ist statt möglichst tricky. 😉

Auch hilft es sich die Frage zu stellen: Welche Informationen könnten einem späteren Leser fehlen, die ich jetzt einfließen lassen kann?

Weitere Informationen zu diesem Thema findet ihr in einem etwas allgemeiner gehaltenen, dafür ausführlicheren Artikel:
Trockene Kommunikation- Warum es nicht immer auf Effizienz ankommt.