Githubで「Mermaid」なる記法で図が書けるようになったらしい

たまに技術者らしいことを…。

まぁ、IT技術者の、先端情報をおっかけてるような方々は恐らく、そうではなくてもそういった人をTwitter等でフォローしていれば目に入った人もいたかとは思いますが、タイトルの通り、Githubで「Mermaid」なる記法で、を書けるようになったらしいです。

github.blog

Mermaid記法の面白さ

Mermaid記法で「面白いな」と思ったのが、ヒューマン・フレンドリーと言うか、人間にとって親しみやすい記法になっているところです。例えば上記の例で

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

となっていますが、果たしてこれを全くみないで「さぁ設計してくれ」と言ったらどういう設計になりますでしょうか?意外とこういう設計に陥りがちなんでは、と思っています(悪いことではないんですが)。

- type: TD
- A
  - B
     - D
  - C
     - D

はい。YAMLです。勿論これはこれで悪くはないんですが、YAMLと言う前提を知らなければ直感的に理解しやすいかどうか…?と言うのはあるかも知れません(ツリー構造とか)。そこを独自フォーマットにしたのはなかなかおもしろいところです。

これならばエンジニアじゃない人に「こういう書き方で書いてくれ」と言ってもそこまで嫌がられはしない気がします。矢印はまんま「-->」ですしね。かなり人間に親しみやすいフォーマットになっているんじゃないかなと思っています。

テキスト情報として管理できる利点

昨今、インフラにおいては Ansible / Terraform なんてのが登場し、テキストベースで管理出来るようになりました。これが出来るとバージョン管理が出来ますし、またレビューやDiffの参照もしやすく、色々メリットがありました。

そして今度は Mermaid の登場によって図においても、同様のメリットを享受する事が出来ます。

かれこれ長い事図においてはどうしようもなく、画像ファイルやExcel…なんて時代が続きましたが、Mermaid の登場によりこれらは一掃出来そうです。

それらがついに過去の遺産となる日が来たか…!?という感じで、新たな時代の到来を感じたグッドニュースでした。