#135 Design Documents & RFCs: Der Weg zu besserer Software-Architektur

Engineering Kiosk

Design Documents und Request for Comments (RFCs): Die Engineering Art der Planungsphase

Wir alle haben schon mal von einer Planungsphase gehört, um ein neues Projekt zu starten, und denken dabei an aufgeblasene Prozesse und lange Wasserfall-Diagramme. Und das Engineering-Team fragt sich oft: Wann kommen wir endlich mal zu den Details?

Da kommen die Begriffe Design Documents und Request for Comments (RFCs) ins Spiel.

Das doofe nur … Jemand muss diese Dokumente auch schreiben.

Und da sind wir bei gleich zwei von Andy's Lieblingsthemen: Schreiben und Design Docs.

Wir klären, wozu Design Documents eigentlich gut sind, worauf es ankommt, wo der Unterschied zu RFCs ist, ob das ganze nicht ein riesiger Wasserkopf ist, um einfach Dinge auf die Straße zu bringen und welche Kultur das ganze benötigt.

Viel Spaß.

Bonus: Wer schreibt, der bleibt.

Das schnelle Feedback zur Episode:

👍 (top) 👎 (geht so)

Feedback

• EngKiosk Community: https://engineeringkiosk.dev/join-discord
• Buy us a coffee: https://www.buymeacoffee.com/engineeringkiosk
• Email: [e-mail]
• LinkedIn: https://www.linkedin.com/company/engineering-kiosk/
• Mastodon: https://podcasts.social/@engkiosk
• Twitter: https://twitter.com/EngKiosk

Gerne behandeln wir auch euer Audio Feedback in einer der nächsten Episoden, einfach die Audiodatei per Email an [e-mail].

Links

• RFC und Design Doc Templates von verschiedenen Firmen: https://blog.pragmaticengineer.com/rfcs-and-design-docs/
• Public RFCs von SourceGraph: https://drive.google.com/drive/folders/1zP3FxdDlcSQGC1qvM9lHZRaHH4I9Jwwa?ref=blog.pragmaticengineer.com
• RFC Proposal von SourceGraph: https://docs.google.com/document/d/1zInJ9mn_SePKjS8dLHS1EDt2_gUEkCKD544bDDSuJek/edit#heading=h.trqab8y0kufp
• RFC Process von SoundCloud: https://philcalcado.com/2018/11/19/a_structured_rfc_process.html
• RFCs von RazorPay: https://github.com/razorpay/blade/tree/master/rfcs
• RFCs von Couchbase: https://github.com/couchbaselabs/sdk-rfcs/tree/master/rfc
• How to write an effective design document: https://rinaarts.com/how-to-write-an-effective-design-document/
• Design Docs at Google: https://www.industrialempathy.com/posts/design-docs-at-google/
• Design Documents vom Service Mesh Istio: https://github.com/istio/istio/wiki/Design-Doc-Links
• Kafka Improvement Proposals (KIP): https://cwiki.apache.org/confluence/display/KAFKA/Kafka+Improvement+Proposals
• Internet Engineering Task Force RFCs: https://www.ietf.org/process/rfcs/
• How and Why RFCs Fail: https://candost.blog/how-and-why-rfcs-fail/
• Oxides Request For Discussions: https://rfd.shared.oxide.computer/
• Engineering Episode #130 Wie gutes UX-Design entsteht mit Robin Titus: https://engineeringkiosk.dev/podcast/episode/130-wie-gutes-ux-design-entsteht-mit-robin-titus/
• Engineering Kiosk Episode #66 Stressfreie Produktivität in der hektischen Welt mit Getting Things Done: https://engineeringkiosk.dev/podcast/episode/66-stressfreie-produktivit%C3%A4t-in-der-hektischen-welt-mit-getting-things-done/
• Checklist Manifesto: How to Get Things Right: https://www.amazon.de/Checklist-Manifesto-ATUL-GAWANDE/dp/0312430000/ref=sr_1_1

Sprungmarken

(00:00:00) Intro

(00:01:15) Welche Relevanz haben Design Documents?

(00:07:25) Was ist ein Design Document?

(00:15:23) Wer schreibt das Design Document? Wie startet man?

(00:21:26) Mein Design hat Abhängigkeiten zu anderen Teams

(00:26:59) Design Document als zeitlicher Overhead

(00:31:56) Wie detailliert und lang soll ein Design Document sein?

(00:41:12) Request for Comments (RFCs) als ursprung für Design Documents

(00:50:10) Schreibtipps für dein erstes Design Document

(00:56:13) Box ticking exercise und Entscheidungs-Fatigue

Hosts

• Wolfgang Gassler (https://mastodon.social/@woolf)
• Andy Grunwald (https://twitter.com/andygrunwald)

Feedback

• EngKiosk Community: https://engineeringkiosk.dev/join-discord
• Buy us a coffee: https://www.buymeacoffee.com/engineeringkiosk
• Email: [e-mail]
• LinkedIn: https://www.linkedin.com/company/engineering-kiosk/
• Mastodon: https://podcasts.social/@engkiosk
• Twitter: https://twitter.com/EngKiosk