Hol euer Lieblingskissen hervor, es isch Zit für es paar Diskussione über s langweiligschte Thema vo alle - d'Dokumentation. Glaubt’s oder ned, am Afang vo de Entwicklungszite het das e wahre und wichtigi Ablieferig gsi.
D'Dokumentation isch (und isch no in paar Branche) e separate Beruf gsi. Was isch de Sinn hüt? Natürli, es z'schaffe, dass Entwickler verständlicher, wie d'App funktioniert, bevor si si ändere, und ohni dass si Wuche damit verbringe, Code z'umgekehrt z'ingeniöre.
Ich bi ehrlich, um eure Zit z'sparen. Es isch wirklich kei Notwendigkeit meh für detaillierti Dokumentation. Wenn ihr Standardframeworks verwändet, si die scho durch dejenige, wo si underhaltet, dokumentiert. Und das bringt euch scho e Wäg. Zweitens, niemand wird’s läse. Tut mir leid, si werd’s ned läse.
Es isch drum viel besser, sich dra z'fokussiere, Dokumentation vo Teile vom Code z'schriebe, wo komplex sind, wo viel Geschäftslogik enthalte und wo e wichtigi Funktion in eurer App usfüehre.
E Dokument vo 3-5 Seiten, wo d'Funktionalität hochiwiisig beschribt, mit Details über Status oder was si cha si, wird gälse, will’s umfassend und schnell z'verstehen isch.
Alli Dokumentation muess gwartet wärde, drum esch’s e gueti Idee, nachdäm ihr komplexi Logik für e Funktion kodiert händ, d'wichtigschte Sache drüber z'schriebe. Ihr werdet euch speter danken.
Lies meh in "Der CTO Playbook" verfügbar uf Amazon/Kindle.
Mir si es Schwiizerischi Firma (LLC) mit Sitz z'
Schwiiz.