← ...
project 14: the system design documentation
project 14: the “system design” documentation
scenario: you are handing over the project to a new engineer. the mission: create a high-level architecture diagram and a “runbook.”
- tech: draw.io, markdown.
- challenge: communication is the hardest engineering skill.
- dev to prod:
- create a diagram linking kafka, spark, s3, redshift, and airflow.
- write a
readme.mdexplaining how to recover if the kafka broker dies. - prod requirement: this is your interview “show and tell” artifact.