Zenn
🔰

【初心者】AWS アーキテクチャ図を書くときの公式ルールをまとめてみた

2023/09/18に公開
AWS
#
アーキテクチャ
#
設計
初心者向け
#
doc
tech

こんにちは！@Ryo54388667です。

AWSアーキテクチャ図を正確に作成するための基本的なガイドラインを読んでまとめてみました。

https://twitter.com/Ryo54388667

参考ページ(公式ドキュメント)
https://aws.amazon.com/jp/architecture/icons/

(2023/09/25 スライド追記)

📍 AWSアーキテクチャ図 について

よくプレゼンテーションやアプリケーションで見かける図のことです。
なかなか、ルールまで確認している人は少ないのではないでしょうか？
僕は雰囲気で書いていたので自戒を込めて書いていきます。。

↓ AWSアーキテクチャ図とは、こんな感じのもの

 
 

📍 ルールについて

グループについてのルール

  • グループボックスの右下隅を使用してサイズを変更すること。
  • グループ内にさらにグループがある場合、内部のグループには少なくとも0.05のバッファが必要。

❌ : NG

  • 承認されていないグループアイコンを利用すること。
  • グループアイコンのサイズを変更すること。

 

グループについては、僕の場合は、AWS cloud 環境の境界とリージョンとAZくらいしか意識したことないです。
IoTが絡んだり、micro service のアーキテクチャになってくると複雑度が増し、より一層グループを意識することがあるかもですね!

 
 

アイコンについてのルール

  • プレゼンテーションで使用する場合にのみ、スケールアップまたはスケールダウンが許可されている。アイコンの整合性を維持するには、サイズ変更中にShiftキーを押したままにする。
  • アーキテクチャ図の場合は、事前に定義されたサイズのアイコンを使用し、サイズを変更しないこと。

❌ : NG

  • サービスアイコンをトリミングすること。
  • アイコンを反転または回転させること。
  • アイコンの形を変更すること。

 

アーキテクチャ図の場合は、事前に定義されたサイズのアイコンを使用し、サイズを変更しないでください。

特に、このルールを破っていた気がします。。反省です。。
アクセシビリティ等がテストされた上でのサイズ、色なので、 変更してはならん！ ということらしいです。

「小さいし、見えづらいから大きくしちゃえっ！！」
これはNGということですね。。

テックブログやWeb上にアーキテクチャ図を記載する場合は元のサイズが好ましいということです。

 
 

矢印についてのルール

  • プリセットの矢印を図にコピーして、正しいフォーマットを維持する。編集するには、矢印をクリックし、Shiftキーを押したままにすること。
  • 新しく矢印を作成する。プリセット矢印は「Open Arrow」を使用すること。

❌ : NG

  • プリセットまたはデフォルトの矢印以外のものを使用すること

 

僕なら色を変えそうですが、それもNGっぽいですね！
ちなみに、Open Arrow についてはこの図がわかりやすかったです。引用URL

 
 

アイコンのラベルについてのルール

  • AWSのサービス名は2行以下でなければならない。
  • AWSまたはAmazonには常にサービス名を添付する必要がある。
  • 行は決して単語の途中で折り返してはいけない。

❌ : NG

  • Elastic BeanstalkのELBやElastic Load Balancingなど、さまざまなサービスの省略形を複製する。
  • 「Amazon (改行) サービス名」と表記する。(中央の図)
  • 単語の中央で行を変える。(右の図)

 

  • 「Amazon (改行) サービス名」と表記する。(中央の図)
  • 単語の中央で行を変える。(右の図)

これ、やりがちではないでしょうか？
QuickSight でひとくくりで、Quick ( 改行 ) Sight はNGです。
ただ、サービス名がどこからどこまでがひとくくりなのか、僕は判別できないなーと思いました。その都度、ドキュメントを確認ですね。

 
 

番号についてのルール

  • 事前に定義されたサイズ、色で吹き出しを使用しフォーマットすること。
  • 左から右、上から下、時計回りなど、できるだけ直線的に番号を並べること。
  • コールアウトの配置はできるだけ一貫すること。

❌ : NG

  • 同じ図内でコールアウトサイズを混在させること。
  • コールアウト内の色またはフォントサイズを変更すること。
  • 文字やその他の記号を使用すること。
  • コールアウト形状を手動でサイズまたはストレッチすること。
  • 新しいコールアウト図形を作成すること。

 

僕はまず、「callout」 がわかりませんでした。。

callout は、イラストや技術図面などの一部に線を引いて、機能などを説明するテキストのこと

こちらの記事がわかりやすかったです。感謝！
矢印や吹き出しで細く説明するようなものをcallout と呼ぶのですね。知らなかったです！

いろいろとルールが書かれていますが、「一貫していること、統一されていること」 が大事ということですね。

 
 

📍 最後に

最後に、公式が出している模範的なアーキテクチャ図を載せておきます！

ex.1

 

ex.2

 

最後まで読んでいただきありがとうございます!
気ままにつぶやいているので、気軽にフォローをお願いします！🥺
https://twitter.com/Ryo54388667

Discussion