技術とかの雑なToday I Learnedメモ

わかりやすいシステム構成図の書き方を読んだ

わかりやすいシステム構成図の書き方を読んだ

わかりやすいシステム構成図の書き方 - Qiita

読んだ。

図を描くことに関して、自分はめちゃくちゃ初心者なのでまずこれを参考にしようと思います。

この記事で挙げられてる分かりにくい点は、

  • 製品名は書いてあるが「役割」が書いていない
  • データと処理が区別できない
  • データの流れと制御の流れが区別できない

つまりこれらを解決することで分かりやすい図を描ける。

製品名は書いてあるが「役割」が書いていない

これは製品の名称だけではなく役割もちゃんと書くのが大事。

役割がないと、詳しくない人は結局何するかわからない。

データと処理が区別できない

コンピュータシステムはつきつめると「データを処理する」ことです。必然的に、システム構成図にはデータと処理という大きく異る2つのものが登場するため、それらを異なる形で表現し書き分けるとわかりやすくなります。

「データ」と「処理」に分ける。

データと処理でアイコンを変える例が記事にあるが、これだととても分かりやすい(スッと頭に入ってきやすいと自分は感じた)

データの流れと制御の流れが区別できない

これが個人的に最も難しいというか、パッと聞いただけではすぐに理解できないこと。

データの流れを書く場合は、処理を起点としてデータに対して矢印を書きます。ポイントは矢印の起点を処理にすることです。これにより、処理が能動的にデータにアクセスしにいっている様子がひと目でわかります。

なるほど。データの流れは「処理→データ」のように処理が起点になっている。

制御の流れは、ある処理が別の処理を呼び出す際のことであり、呼び出し元となっている処理を起点として、呼び出し先の処理に向けて破線を書きます。

制御の流れは「処理→処理」のように、起点の処理が別の処理を呼んでいるもの。

これだとパッと見ただけで理解できる。

まとめ

より大規模なシステム構成図やアプリケーションの詳細な動きを示したい場合は、従来からあるUMLのシステムコンポーネント図やシーケンス図を検討することをおすすめします。

これはあくまである程度小さく粗めの粒度で描くときのもので、より大きかったりより細かく記したい場合は別の図を使うのがいいらしい。

でも概要や流れを把握することは大事なのでこの図の描き方は良いなと思いました。