Dokumentation

Auf der richtigen Ebene zur richtigen Zeit

Holen Sie Ihr Lieblingskissen hervor, denn es ist Zeit für eine Diskussion über das, was für viele das langweiligste Thema ist – die Dokumentation. Glauben Sie es oder nicht, zu Beginn der Entwicklungszeiten war dies ein echtes und wichtiges Ergebnis.

Dokumentation war (und ist in einigen Branchen immer noch) ein eigenständiges Berufsfeld. Was ist der Zweck heute? Natürlich, um es Entwicklern zu erleichtern, zu verstehen, wie die Anwendung funktioniert, bevor sie geändert wird, und ohne Wochen damit zu verbringen, den Code rückwärts zu entwickeln.

Ich werde sehr direkt sein, um Ihre Zeit zu sparen. Es gibt wirklich keinen Grund mehr, detaillierte Dokumentation zu haben. Wenn Sie Standard-Frameworks verwenden, sind diese bereits von denjenigen dokumentiert, die sie warten, und das reicht schon weit. Zweitens wird es niemand lesen. Tut mir leid, aber sie werden es nicht tun.

Es ist daher viel besser, sich darauf zu konzentrieren, Teile des Codes zu dokumentieren, die komplex sind, schwere Geschäftslogik enthalten und eine wichtige Funktion in Ihrer Anwendung erfüllen.

Ein 3-5 Seiten langes Dokument, das die Funktionalität auf hohem Niveau beschreibt, mit Details zu Statusen oder was es sein kann – wird gelesen, weil es umfassend und schnell zu erfassen ist.

Alle Dokumentationen müssen gepflegt werden, also nachdem Sie einige komplexe Logiken für eine Funktion codiert haben, ist es eine gute Idee, die wichtigsten Dinge darüber niederzuschreiben. Sie werden es später zu schätzen wissen.

Lesen Sie mehr in "Das CTO Handbuch" verfügbar auf Amazon/Kindle.