Clean Code training for your dev team

Software­qualität ist nicht gleich Software­qualität. Wir unterscheiden zwischen innerer und äußerer Qualität, wobei das Augen­merk unserer Clean Code Schulung auf der inneren Qualität liegt - also auf der Qualität des Quell­codes. Adressiert werden die Themen Lesbarkeit, Nach­voll­zieh­barkeit, Test­barkeit und Wandel­barkeit (Evolvier­barkeit).
‍
Die Vorteile eines gemeinsamen Qualitäts­bewusstseins:

• Optimale Grundlage der Zusammen­arbeit
• Gesteigerte Sensibilität für ökonomische Zusammen­hänge
• Besseres Verständnis der Folgen schlechter Code­qualität

Die Clean Code Development Initiative gründet auf dem Buch Clean Code von Robert C. Martin. Darauf auf­bauend haben die zwei deutschen Ent­wickler Stefan Lieser und Ralf Westphal 2009 ein norm­­gebendes Werte­­system für Soft­ware­­ent­wickler konzipiert, das neben Lern­modulen auch eine Sammlung von Prinzipien und Praktiken beinhaltet. An oberster Stelle thronen die vier Clean Code Werte: 

• Korrektheit
• Wandelbarkeit
• Produktionseffizienz
• Kontinuierliche Verbesserung

Flow Design ist eine Technik, um Quell­code sinnvoll zu planen und zu strukturieren - noch bevor er geschrieben wird. Dabei geht es immer um die Frage, wie man von einer Anforderung zum tatsächlichen Code gelangt. Die Technik arbeitet dabei mit hierarchischer Zer­legung der Anforderung auf ihre kleinsten Ein­heiten: Daten­flüsse.
‍
Die Vorteile von Flow Design:‍

• Quell­code kann bis ins Detail geplant werden, ohne das Big Picture aus den Augen zu verlieren
• Das gesamte Team wird in den Software-Design­prozess involviert
• Positive Auswirkungen auf Verantwortlich­keiten im Team und auf die Lesbarkeit des Codes
• Ideale Vorlage für eine durch­dachte Test­suite

Automatisierte Tests sorgen nicht nur dafür, dass der Quell­code korrekt arbeitet, sie sind auch ein gutes Mittel Anforderungen besser zu verstehen und zu definieren. Und sie sorgen für Vertrauen und Sicher­heit bei den Entwickler:­innen. Allerdings ist das Schreiben von Tests sowie komplexer Test­suites, bestehend aus System-, Integrations- und Unit Tests, ein Hand­werk für sich. Unsere Trainer vermitteln grund­legende Konzepte, Techniken und die nötigen Technologien, wie bspw. SonarCloud, um die Test-Coverage im Back- und Frontend zu steigern und bei Penetrationtests gute Ratings zu erzielen.

Obwohl alle Clean Code Prinzipien ihre Daseins­berechtigung und Wichtig­keit haben, gibt es Prinzipien, die eigentlich immer angewendet werden sollten und damit auch wichtiger Teil unserer Schulungen sind: 

• SRP - „Single Responsibility Principle“: Eine Methode oder eine Klasse sollte immer nur eine Funktion haben
• DRY - „Don’t Repeat Yourself“: Duplikate im Code sind immer zu vermeiden
• IOSP - „Integration,Operation, Segregation Principle“: Eine Applikation ist in Funktions­einheiten aufge­gliedert, die wie in einer Kette aufgerufen werden
• YAGNI - „You Aint Gonna Need It“: Fokus auf die jetzigen, nicht auf zukünftige, potenzielle Probleme

Abhängigkeiten im Quellcode können dabei helfen Strukturen zu ver­ein­fachen. Zu viele Abhängig­keiten können jedoch dazu führen, dass Code-Änderungen mit unerwarteten Neben­wirkungen ein­her­gehen und der Code mit der Zeit un­über­sichtlich wird. In unseren Schulungen geben wir den Teil­nehmenden Techniken und Best Practices an die Hand, um Abhängigkeiten effektiv zu managen und wenn nötig aufzulösen.

Pair Programming, Pairing oder auch Tandem-Programmierung beschreibt eine Clean Code Entwicklungsmethode, bei der zwei Entwickler:innen gleichzeitig an einem Problem und am gleichen Code arbeiten. So sinnvoll die Herangehensweise in manchen Fällen ist, so ineffizient kann sie in anderen Fällen werden. Unsere Trainer geben Best Practices, wie und wann die Methode Sinn macht.

Clean Code Development darf nicht zum Selbstzweck verkommen. Beschäftigt man sich mit Quellcode, wird man immer wieder Stellen finden, die man optimieren kann. Aber irgendwann ist das einfach nicht mehr produktiv und steht nicht mehr im Verhältnis zu den Kosten. Die Frage lautet nur: wann?
In unseren Clean Code Schulungen geben wir den Teilnehmenden Tools an die Hand, um zur richtigen Definition of Done zu gelangen – individuell abgestimmt auf das Projekt, die Anforderungen und auf die Unternehmensziele.

Genauso wichtig, wie das Hand­werkliche, ist das richtige Mind­set. Dabei geht es darum, die Clean Code Werte immer wieder aufrecht zu erhalten und auf sie hin­zu­weisen. Die Inhalte werden dem­nach nicht in einer ab­ge­schlossene Session vermittelt, sondern parallel über die gesamte Schulung hinweg. Im Detail geht es um agiles Arbeiten, Effizienz durch Fokus, Reflexion, Ver­ant­wortlichkeiten, Erwartungs­haltungen und Zusammen­arbeit.

Nur durchs Machen, lernt man Clean Code. Deshalb legen wir sehr großen Wert auf einen hohen Praxis­anteil in unseren Schulungen. Das sind einer­seits kleine Übungs­aufgaben, um ein theoretisch besprochenes Thema zu vertiefen. Anderer­seits sind es gemeinsame Code-Reviews, in denen die Ergebnisse der Übungs­aufgaben oder andere Code-Beispiele mit allen Teil­nehmenden im Detail besprochen werden.

Code Checks einer bestehenden Applikation sind ein guter Einstieg, um herauszufinden, wo ein Team mit seiner Code­basis steht. Ähnlich wie in einem Code-Review wird der Code dabei durch unsere Trainer sowie den ursprünglichen Entwickler:innen analysiert. Durch solch eine reflexive Herangehensweise lernen die Teil­nehmenden viel über sich und ihre Vor­gehens­weise.