Mein persönlicher Blog. Meine Gedanken.
Meine Meinung.
Ungefiltert. Gründer und technischer Leiter von urbanvention, einer Technologie-Agentur welche die Planung und Entwicklung von Webapplikationen anbietet. Wir konzentrieren uns aufs bauen moderner Systeme, sind begeisterungsfähig für schlaue Ideen und liefern elegante Lösungen.
Großartige Dokumentation schreiben
writing great documentation, by jacob kaplan-moss: jacobian.org/writing…
Cooler Link, danke!
Das andere Extrem ist:
documentation considered harmful
Ich find es schon ziemlich geil, wenn man ne gute Dokumentation ließt, andererseits ist Dokumentation nicht so lebendig, wie das was man eigentlich dokumentiert.
Es kommt doch super häufig vor, dass die Dokumentation out of sync geht mit dem was man eigentlich dokumentiert.
Ich find das kritisierte automatische generieren von Dokumentationen aus dem Quellcode eigentlich wichtig um genau dieser desynchronisation entgegenzuwirken.
Auf jeden Fall ist Dokumentation, wenn diese super aufbereitet wurde hammer, aber wenn ich alles dokumentieren würde und immer aktualisieren müsste (insbesondere wenn es um die Cross-Plattform-Kompatibilität geht) und kontinuierlich prüfen ob dies und das mit den aktuellen Abhängigkeiten weiter funktioniert, wär ich am Ende des Tages nicht mehr produktiv, und ich würde nicht mehr das machen, was ich wirklich liebe.
