アーキテクチャ図の書き方

前提条件

アーキテクチャを把握しておく

ここでいうアーキテクチャ図はインフラアーキテクチャを想定している

書き方

伝えたいことを書き出す

複数あってもいいが多すぎると情報過多な図になって使われなくなるので適度に止める

伝えたいことをもとに描くべきこととそうでないものを整理する

頭の中だけでもリストを作っても良い

リストした伝えたいことをネットワークごとに分類する

とりあえず図示する

ホワイトボードや裏紙に書く

管理ツールで同様の図を描く

draw.ioなどであればバージョン管理できるのでおすすめ

vscodeだとdrawioの拡張があってvscode上で書ける

体裁を整える

伝わる内容になっているかセルフレビューする

必要に応じて実施

完成

GIt管理などに載せて継続的にメンテしていく