Wir starten heute mal wieder mit nem Heise -Kommentar der Woche. Dort geht es um gut lesbaren Code. Wir sind nicht so aufgeregt. Die Provokationen prallen doch eher ab.
Es geht auch irgendwie um Kommentare. Irgendwie kommen wir da auch auf das Thema Dokumentation. Und auf LaTex.
Wenn man LaTex sagt, dann redet man über Diplomarbeiten. Dann fällt Holger seine Diplomarbeit in die Hand. Und dann faselt Holger mit glänzenden Augen von seinen Erfahrungen mit JavaScript in der Welt der Prozessleittechnik. Und über JavaBeans.
Bene ist nächstes Mal dran!
Eigentlich wollten wir mal wieder was anderes machen. Aber wir bleiben beim Thema. Wir bleiben am Ball. Verwerfen spontan unser geplantes Thema. Und biegen hart ab. Wir biegen hart ab in Richtung Dokumentation!
Wir diskutieren, ob wir LaTex nochmal nehmen würden, oder ob Markdown und Co. Alternativen sind. Irgendwie ist LaTex ja schon geil!
Wir starten natürlich mit JavaDoc. Bene findet das geil. Holger nicht so. Wie geht es denn eigentlich in JavaScript? Hat das vielleicht sogar Vorteile? Was macht denn Scala? Gibt es eine Dokumentationsmonade?
Wir diskutieren alternative Formen der Dokumentation als Prosa. Elixir DocTest ist mal wieder Thema. Welche Rolle spielen Themen wie Tests oder Typen?
Cucumber und Fitnesse sind mal wieder Thema.
Natürlich gehen wir auf das Wiki als Dokumentationsgrab ein. Macht Dokumentation, die mit dem Code versioniert wird, alles besser?
Dann packen wir die großen Gesten aus. Wir visionieren das nächste große Ding der Dokumentation. Wo habt ihr es zuerst gehört?
Wir schweifen dann noch ab Richtung Online-IDEs, um dann bei einem unserer Lieblingsthemen zu landen. Dokumentiert guter Code sich selber? Womit wir den Kreis zum Heise-Kommentar schliessen!
Das war ein Rundumschlag. Ein überraschender Rundumschlag. Irgendwann machen wir das andere Thema noch. Versprochen. Vielleicht. 🙂
Was denkt ihr zum Thema Code-Dokumentation? Oder zu lesbarem Code? Seht ihr das ähnlich. Oder waren wir kontrovers an einigen Stellen?Schreibt uns! Habt ne schöne Woche!
Links
- Der Heise-Artikel der Woche: Es geht um lesbaren Code.
- Der Heise-Kommentar der Woche: Es wird widersprochen.
- Die Kaffeemühle der Woche: Es wird gemahlen!
- Das Meetup der Woche: Holger war bei den Webworkern. Geht da auch mal hin.
- Das Meetup war bei Sipgate. Super da. Und die haben einen großen Kühlschrank.
- Holger war auch noch bei der Softwerkskammer in Nürnberg. Das stand ihm bei der Folge noch bevor.
- Holger hat seine Diplomarbeit am Institut für Prozessleittechnik in Aachen geschrieben.
- LaTex, BibTex und co. sind irgendwie geil.
- Dojo war damals ein heller Stern am JavaScript-Framework-Himmel. Aus heutiger Sicht vielleicht etwas überambitioniert.
- Elixir DocTest. Finden wir auch geil.
- Die Java-Variante nicht ganz so. Ist aber auch geil.
- Von Fitnesse ist Holger nicht so überzeugt.
- Die Online-IDE Gitpod ist eine super Idee.
- Eclipse Che kennen wir nicht so gut. Die Idee klingt aber auch gut.
Bier
Heute gibt es eine Auswahl der holländischen Brauerei Brouwersnös:
- Wir starten mit nem 4 Granen Willemken. Belgisch, Weizen, Pfirsich. Schmeckt uns.
- Dann gibt es das Pale Ale Frolijke Frans. Riecht nach Frucht. Schmeckt nach nix. Ist nicht so.
- Wir schliessen mit dem Tweeduuster. Ein belgisches Dubbel. Joa. Ist ok. Schmeckt am definiertesten. Hmmmm.
Habe ich es eigentlich überhört oder habt Ihr nicht so richtig über Architektur-Doku gesprochen?
Habt Ihr eine Meinung zu Arc 42 oder zu C4, was haltet ihr von Architecture Decision Records?
Irgendwann habe ich auch mal was über PAP und Strukturdiagramme gelernt, aber hat das mal jemand im Wildlife gesehen? Ist da nicht Lehre und Realitat zu weit auseinander?
Zudem habe ich den den rant über Enterprise UML vermisst… oder bin ich da eingepennt?
So jetzt habt ihr auch mal einen Kommentar auf eurer Seite – schön oldschool 😛
Hi Johannes,
ich glaube da hast du nichts überhört. Wir haben das Thema tatsächlich wohl vergessen. ? Muss aber zugeben, dass ich weder von Arc42 noch von C4 Ahnung habe…
Gruß
Benedikt
Oha! Arc42! Da habe ich in einem früheren Leben etwas mehr mit gemacht. Hat einige interessante Aspekte, ist aber auch irgendwie sehr sperrig. Finde die Idee der Produktpverpackung immer noch sehr geil.
C4 wollte ich mir in dem Rahmen immer noch mal genauer angeschaut haben. Das sah mir immer recht vielversprechend aus. Aber irgendwie hab ich das nie richtig vertieft.
ADR finde ich sehr spannend, habe ich aber auch noch nie im Wildlife gesehen. Architekturentscheidungen direkt mitversioniert zu haben, klingt schon nett.
Ich glaube grad, dass Architekturdokumentation ne eigene Folge wäre. ?♂️