Gehen Sie mit der App Player FM offline!
094 | Zwischen IDE und Markdown: Dokumentation, die Developer glücklich macht
Manage episode 461871745 series 3432291
Warum scheitert Dokumentation so oft daran, wirklich hilfreich zu sein? Was sollte dokumentiert werden, warum ist das überhaupt nötig und wie macht man es richtig? Es geht um die großen und kleinen Hürden im Alltag – von ADRs über Readmes bis zu Dokumentations-Tools und dem ewigen Konflikt zwischen IDE-Nähe und veralteten Prozessen.
Wir sprechen über Onboarding, Tests als Doku und ob wir Doku selbst nicht auch wie Code behandeln können.
Zusätzlich werfen wir einen Blick auf Workflows abseits von Best Practices, die Rolle von geschlossenen Systemen mit Interfaces und die Verantwortung, die bei jedem Teammitglied liegt, damit Dokumentation aktuell bleibt. Mit einem pragmatischen Fokus gehen wir der Frage nach, wie wir aus der Theorie endlich Praxis machen können – ohne dass die Infos im Slack-Chaos oder in längst vergessenen Markdown-Files verschwinden.
Community:
💜 Werde Teil der IOOB Discord Community: https://discord.gg/bbC5c4vvQY
Links:
https://stackoverflow.blog/2024/11/26/your-docs-are-your-infrastructure/
Kontakt:
👉 http://ioob.de
📬 [email protected]
𝕏 http://x.com/IoobPodcast
📺 http://youtube.com/@ioobpodcast
112 Episoden
Manage episode 461871745 series 3432291
Warum scheitert Dokumentation so oft daran, wirklich hilfreich zu sein? Was sollte dokumentiert werden, warum ist das überhaupt nötig und wie macht man es richtig? Es geht um die großen und kleinen Hürden im Alltag – von ADRs über Readmes bis zu Dokumentations-Tools und dem ewigen Konflikt zwischen IDE-Nähe und veralteten Prozessen.
Wir sprechen über Onboarding, Tests als Doku und ob wir Doku selbst nicht auch wie Code behandeln können.
Zusätzlich werfen wir einen Blick auf Workflows abseits von Best Practices, die Rolle von geschlossenen Systemen mit Interfaces und die Verantwortung, die bei jedem Teammitglied liegt, damit Dokumentation aktuell bleibt. Mit einem pragmatischen Fokus gehen wir der Frage nach, wie wir aus der Theorie endlich Praxis machen können – ohne dass die Infos im Slack-Chaos oder in längst vergessenen Markdown-Files verschwinden.
Community:
💜 Werde Teil der IOOB Discord Community: https://discord.gg/bbC5c4vvQY
Links:
https://stackoverflow.blog/2024/11/26/your-docs-are-your-infrastructure/
Kontakt:
👉 http://ioob.de
📬 [email protected]
𝕏 http://x.com/IoobPodcast
📺 http://youtube.com/@ioobpodcast
112 Episoden
Alle Folgen
×Willkommen auf Player FM!
Player FM scannt gerade das Web nach Podcasts mit hoher Qualität, die du genießen kannst. Es ist die beste Podcast-App und funktioniert auf Android, iPhone und im Web. Melde dich an, um Abos geräteübergreifend zu synchronisieren.