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

これをやった経緯

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

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

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

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

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

PlantUMLがあるじゃないか

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

参考にした記事

できあがったのがこちら

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

まとめ

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