ひとりマーメイド25日目
結局マーメイドってどうなんですか？
概要
ひとりマーメイドAdvent Calendarを通して嫌というほどマーメイドを書いたので、その中で感じたマーメイドの良いところと良くないところをまとめます。
↓↓前回の記事はこちら！！
マーメイドの良いところ
1. テキストでダイアグラムを記述できる
マーメイドの一番の良さはダイアグラムをテキストで記述できることです。筆者はこれまでドキュメントや資料を作成する際、図を挿入するために多くの時間を費やしてきました。GUIによる作図には多くの時間と労力が必要になります。しかしマーメイドはテキストによる記述を自動でレンダリングしてくれるため、圧倒的に時間を短縮することができます。特に何事もコードとコマンドで操作したがるエンジニアの皆さんにはぴったりのツールと言えるでしょう。
またマーメイドはコードをレンダリングしてダイアグラムを描画しているため、再現性のある作図ができるというところも便利なポイントです。
2. スタイリングが充実している
マーメイドはテキストレンダリング式の作図ツールでありながら、かなり自由にダイアグラムをスタイリングすることができます。色やフォント,テーマなどスタイリング要素が多くあるため、目的や好みに合わせて自由に変更することができます。さらにマーメイド全体の共通のスタイリングだけでなく、それぞれのダイアグラムに特有のスタイリングも用意されています。
またスタイルの適用方法が充実しており、ディレクティブ, css, json など好みの方法を用いて自由にスタイルを定義することができます。
3. アップデートのスピード感がすごい
マーメイドはまだまだ発展途上のツールであり、日々開発が進められています。現在も新たなダイアグラムの実装や文法の追加などがおこなわれており、ドキュメントの中でも一部これを理由に文法が不確定であると記載されています。筆者が Advent Calendar の執筆を進めている2週間の間だけでもドキュメントサイトが大幅アップデートされ、さらに公式エディタに新たなダイアグラムが追加されました。今後さらにツールが充実していくことが期待できます。
マーメイドの良くないところ
1. エディタ間のバージョン格差
マーメイドは公式エディタだけでなく、Notion や VSCode など様々な場所で記述することができます。しかしマーメイドのアップデートの勢いが凄まじいせいか、各エディタで使用されているレンダラーのバージョンが悉く異なっています。そのため、VSCode では レンダリングできたけど Notion では表示されないみたいなことがよく起こります。特に Qiita に埋め込まれているレンダラーはバージョンが古いためうまくダイアグラムが表示されないことが多く、筆者は何度もこのバージョン格差に悩まされました。
2. 情報が少ない
これもまたアップデートが激しいためか、新しいダイアグラムほど情報が少ない傾向にあります。特に日本語の情報が非常に少ないことに加え、「マーメイド」というワードのSEOがあまり良くないことから情報収集には非常に苦労しました。
また筆者はQiitaを執筆する上でマーメイドのドキュメントをかなり読み込みましたが、公式ドキュメントでさえほとんど情報が書かれていないダイアグラムもあります。さらに一部ドキュメントの内容と挙動が異なる場面もありました。そのため厳密な文法を完全に把握することは難しいように感じます。（日常使いに支障が出るほどではないので大丈夫ですが。）
まとめ
マーメイドは私たちが作図に費やす労力を大幅に軽減してくれます。また実際に触ってみるとサクサクダイアグラムが出来上がるので結構楽しかったりします。特に環境構築の必要もないので是非一度試していただければと思います。