えを描こう

この記事は

レコチョク Advent Calendar 2021

の03日目の記事となります。

はじめに

会社やチームに所属して何らかのシステムを管理運用する事になった時、引き継がれたり引き継いだりしてシステムを継続して回していきます。
一人で開発、運用しているときはまあ何とかなるかと思いますが、いざ引継ぎとなった時にドキュメント群が充実していない時に、

「あ、これは大変かもなぁ…」

と思う事は無いですか？

ドキュメントがしっかりしていた場合でも、パラメーターシートが主で具体的な全容が見え辛いという事があります。

それは何でだろう？

一つは、視覚から入る情報が少ないから、では無いでしょうか。

視覚から入る情報のインパクト

初めて見るシステム、分野が異なるエンジニアやエンジニアではない方とシステムについて会話する時など、色々と情報を共有する場面があるかと思います。

情報共有の際に文字だけで伝える、もしくは管理者権限付与したから勝手に環境見といてね、という感じだとなかなか辛いものがあります。

だって、全体が分からない(見えてない)から。

システムに関わる際には、まず全体の概要を把握してから細かい部分(自分が担当する部分など)に入っていくと、理解しやすい事が多いです。
もちろん、細かい部分から辿って行ってもいいのですが、より短い時間に全体を把握するには、俯瞰した状態からの方が圧倒的に早いですね。

そういった時に何があると良いかとなった時に、えの有無が重要になります。

そういえば視覚からという意味で、わたしはDTM(SC-88)で耳コピして遊んでた世代なので、スコアがあるとだいぶ楽できるなぁと思っていました。
レコポンを使っていましたので、なおさら知らない方が見ただけだったら何か分からないだろうし…。

え

えには色々なものがあります。
今回はシステムに関する事なので絵画とかそういうのは触れません。

わたしはオンプレミス時代からのネットワーク屋さんなので、散々えを~~描かされて~~描いてきました。

物理構成図
論理構成図

※参考
レコチョクオンプレミス時代の物理と論理構成図

この辺りはネットワーク屋さんは延々とVisioで描いて、ステンシルにこだわったりする職人さんもいらっしゃいますね。

レコチョクだとAWSに完全移行しても、全体基盤として可視化するために同じく概要図や論理図は描いてきています。

※参考
AWS環境に移行してからの構成図の一部

開発目線でも、所謂UMLといったお作法を使って、フローや関連性を可視化しますね。

描き方は様々でも、こういったえで表された情報は、パッと見るだけでも色々分かることがあります。

あー、とりあえずここが情報集約するところねー
このフローだと整合性どうなんの？
今の処理能力だとここがボトルネックにならない？

考えてみてください。

最近はコロナ禍で難しい場合もありますが、ディスカッションする時ホワイトボードにどんなこと描いてますかね？

更新する事が大変

えは最初は結構描きます。アイデアをまとめる時とか設計の時とか。

ただ、システムがリリースされちょっとした改修が行われ…

みなさん、描いたえはちゃんと更新していますか？

「ちょっと古い図で申し訳ないんですが…」

言ってませんか？

世の中にはこういったことを防ぐために、自動で情報取得して可視化してくれる便利なツールが多いです。
みんな同じようなところがめんどくさいと思って、それを解消するためのツールがある。いい世の中ですね。

ネットワークトポロジも自動で出来ればなぁと考えながら、#sh cdpしなくて良いんです。
YAMAHA機器で揃えたら可視化自動でしてくれるって！みたいな事を考えなくて良いんです。

参考

CloudMapper

　ノード数が多くなりすぎると重かった…つらい

Ilograph

　今これがおもしろい

おわりに

えを描けるという事は、理解しているとも言えると思います。
自分のためでもあるのですが、描いたものがあれば共有や引継ぎの時にすごくスムーズに出来る事が多いです。

手動でがんばる、自動で可視化などなど手法は何でもできる時代ですので、えを使った伝え方が出来ているか、見直してみてはいかがでしょう。

明日のレコチョク Advent Calendar 2021は04日目、「AWS re:Invent 今年はハイブリット開催」です。

この記事はレコチョクのエンジニアブログの記事を転載したものとなります。