10
9

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

MarkdownAdvent Calendar 2019

Day 18

PlantUMLでAWSのシステム構成図がなるべく管理される世界観を考えてみた

Last updated at Posted at 2019-12-18

先日、パブリックの方も対応したようです :eyes: :bow_tone2:

リリースノート - Qiita

これをやった経緯

これまで経験してきたプロジェクトでも多くのシステム構成図を作成してきましたが、ER図とか仕様書とか構成図も含め、
ドキュメントってやっぱり最新の状態で管理されないなー :thinking: というのを結構、課題に感じていまして、しばらくどうしたらいいんだろう :question:
と考えを巡らせていたのですが、システム構成図に関してはこうするのはどうだろう :question: という僕以外の優秀なエンジニアの皆様への問題提起となります。

これまでは何が問題だったのか?

  • 図を描きやすいツール(Cacooとかね)を使って構成図を作成していて、開発するソースや使ってるツールとは離れた場所で管理される状態だった :sweat_drops:
  • 開発プロジェクトへ参加した際に最低限必要なもの(ソースとか、ミドルウェアとか、タスク管理ツールとか)の中にいないため、途中から入った人には共有されないこともあった :sweat_drops:
  • 別にこれがなくても正直何も問題ない人もいるので、作ってもそれ以降の修正はされない(バージョン管理されない)状態だった。 :sweat_drops:

どうしたらいいんだろう?

  • 開発してるソースと一緒にGit管理されたほうが良いのでは :question:
  • Githubとかでソース管理してるならもう、 Readme.md とかでシステム構成図確認できる状態にしちゃったほうが良さそう :question:
  • そうなると、Readme.mdMarkdownなのもあり、今後のバージョン管理で変更しやすい状態にするのも考えると、Markdownみたいなものがいい :question:
  • うーん、テキストで図を書けるものって何かなかったっけ :question: :question: :question:

PlantUMLがあるじゃないか :exclamation: :exclamation: :exclamation:

ということで、色々と調べてみた :eyes: :eyes: :eyes:ところ、下記の参考記事が見つかり、軽くQiita:Teamでも試してみたところできちゃったので、
次はQiitaでということでさらに調べてみたところ、応用でできそうだったので、QiitaでPlantUMLであるシステムの構成図を書いてみました。

参考にした記事

できあがったのがこちら :bowtie: :bowtie: :bowtie:

AWSで構成されているあるシステムの開発環境をPlantUML化してみました :thumbsup:
この画像のURLをそのまま こちらのサイト で入力してSubmitすると、元のPlantUML内容も確認できます :eyes:

alt

まとめ

  • システム構成図もちゃんとバージョン管理するなら、PlantUMLで管理したらうまく管理される可能性が高まるかも :question:
  • GithubのReadme.mdで確認できるとなお良しですが、 PlantUMLの公式サイト? が生きてる必要はありそう :question:
  • 同じ流れでER図やユースケース図とかも対応はできそうだなー :thinking: と感じましたが、果たしてどこまでちゃんと管理できるのかしら :question:
10
9
6

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
10
9

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?