Entwickler*innen-Doku lesen und schreiben

Published: Dec. 16, 2019, 6 p.m.

b"Bald ist Weihnachten und Winterpause! Und das heisst: Hallo und herzlich willkommen zur letzten Folge Codestammtisch 2019. Und es ist \\u2014 wie sollte es anders sein \\u2014 mal wieder eine Jubil\\xe4umsfolge. Dieses Mal dreht sich alles um das Thema Dokumentation. Bei Winter IPA mit Tannennadeln und Wacholderbeeren und Cambridge Dry Gin aus Cambridge unterhalten wir uns \\xfcber das Lesen und Schreiben von Dokumentation.\\n\\nWie erleichtern uns Paw, Swagger, der CocoaRESTclient und Postman das Erforschen und Dokumentieren von Netzwerkschnittstellen?\\n\\nUnd wozu kann ich eigentlich Dash, Zeal und devdocs.io nutzen? Spoiler: Damit kann ich Dokumentationen lesen und vor allem durchsuchen. Also wenn der Code nicht genug Dokumentation genug ist!\\n\\nAber was ist, wenn ich nicht nur Dokumentation lesen, sondern sogar selbst welche schreiben will? Wie kann mich Sphinx dabei unterst\\xfctzen? Oder doch lieber einfach eine Reihe von Markdown-Dateien in einem Repo? Oder doch ein Word-Dokument? Auf jeden Fall gilt: Einfach mal anfangen. Ein bisschen Dokumentation ist besser als keine Doku. Und wenn man das mit Styleguides kombiniert, kann man Leute sogar dazu zwingen!!!!\\n\\nUnd damit verabschieden wir uns in die Winterpause 19/20. Habt eine gute Zeit! Die n\\xe4chste Folge erscheint am 13.1.2020, wie immer um 19:00 Uhr!\\n\\nWir bedanken uns wie immer f\\xfcr's Zuh\\xf6ren. Verbesserungsvorschl\\xe4ge, Getr\\xe4nkeempfehlungen, Liebesbekundungen und Kritik bitte wie immer via Twitter an @codestammtisch oder diskret per Mail an hallo-at-codestammtis.ch\\n\\nKurze Werbeeinblendung zum Schluss: Wenn du uns auf Steady unterst\\xfctzt, bekommst du l\\xe4ngere Folgen! Und dieser Werbehinweis entf\\xe4llt!"