Entwickler*innen-Doku lesen und schreiben

Codestammtisch

Bald ist Weihnachten und Winterpause! Und das heisst: Hallo und herzlich willkommen zur letzten Folge Codestammtisch 2019. Und es ist — wie sollte es anders sein — mal wieder eine Jubiläumsfolge. 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 über das Lesen und Schreiben von Dokumentation.

Wie erleichtern uns Paw, Swagger, der CocoaRESTclient und Postman das Erforschen und Dokumentieren von Netzwerkschnittstellen?

Und 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!

Aber was ist, wenn ich nicht nur Dokumentation lesen, sondern sogar selbst welche schreiben will? Wie kann mich Sphinx dabei unterstützen? 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!!!!

Und damit verabschieden wir uns in die Winterpause 19/20. Habt eine gute Zeit! Die nächste Folge erscheint am 13.1.2020, wie immer um 19:00 Uhr!

Wir bedanken uns wie immer für’s Zuhören. Verbesserungsvorschläge, Getränkeempfehlungen, Liebesbekundungen und Kritik bitte wie immer via Twitter an @codestammtisch oder diskret per Mail an hallo-at-codestammtis.ch

Kurze Werbeeinblendung zum Schluss: Wenn du uns auf Steady unterstützt, bekommst du längere Folgen! Und dieser Werbehinweis entfällt!

Kapitel

1. Bis hierhin war alles Vorgeplânkel (00:07:31)

2. Dokumentationen lesen (00:09:34)

3. Dokumentation schreiben und pflegen (00:24:32)

4. Geheimtipp: Wie man Leute dazu bringt, Doku zu schreiben (00:42:03)

5. Beer Review (00:47:00)