Es gibt so viele kleine Perlen in diesem Stück von Yevgeniy Brikman über Dokumentation. Er geht jedoch weit über die reine Dokumentation von Code hinaus und konzentriert sich darauf, wie wir jede Phase unserer Arbeit dokumentieren können, vom Design über den Prozess bis hin zu darüber hinaus.
Hier sind meine Lieblingszeilen, die mich zurücklehnen und "Wahoo!" rufen ließen.
Wenn ein Entwickler deinen Code verwendet, lernt er wirklich eine neue Sprache, also wähle die Wörter darin weise.
…Programme müssen für Menschen geschrieben werden, die sie lesen können, und nur nebenbei für Maschinen, die sie ausführen.
Mir gefällt, wie Yevgeniy vorschlägt, dass wir beim Schreiben von Code zwei unterschiedliche Denkweisen haben müssen: eine, um die verdammte Sache überhaupt zum Laufen zu bringen, und eine andere, um zu erklären, wie und warum wir es auf eine bestimmte Weise getan haben. Zwischen diesen verschiedenen Arbeitsphasen findet ein Kontextwechsel statt.
Wie auch immer, wenn man es so betrachtet, könnte Dokumentation viel mehr als nur ein nettes Extra sein. Stattdessen könnte sie durchaus 50 % der Arbeit ausmachen.