構成を書く｜System Design入門設計判断を数字とコードで確かめる

箱と線だけで書く

構成図に要るのは、箱と線の2つだけです。

箱は部品、線はどちらからどちらへ要求が飛ぶかです。色も影も要りません。

半年後の自分が読んで、どこからどこへ繋がっているか分かれば役目は果たします。

書けば書くほど、古くなる速さが上がります。

台数や設定値を図に書き込むと、変えるたびに図も直すことになります。直さなければ、その図は嘘になります。

数字は別のシートに置き、図は繋がりだけを持ちます。

図を書いたら、2つだけ確かめます。

どの線にも繋がっていない箱が無いか。あるなら、その部品は本当に要るのか、線を書き忘れたかのどちらかです。

Python

# 箱に無い名前へ線が伸びている
# → 書き忘れた箱があるか、名前が違う

読む人には分かりません。app と application が同じものだと知っているのは、書いた人だけです。

図が他人に読まれるのは、たいてい障害の最中です。そのとき名前を照合する余裕はありません。

箱の一覧と線の一覧を受け取り、読める形の行と、繋がっていない箱、無い箱への線を返します。