2023-04-17

Mermaid のドキュメントを読んでみた

Mermaid はちゃんとドキュメント読んだこと無かった、、、のでざっと読んでみた。

https://mermaid.js.org/intro/

いろいろなブログ記事とかであれこれ使い方を見たりはしているからゼロからということではないけど。

読んでみて「そういうことだったのね」とかもいくつかあった。


XX図の書き方とかはわかったが、わかりやすくかけるかどうかはまた別の話で、これはある程度やっていかないといけないなぁという感じ。

自分で使うとしたら、実装前段階の仕様だったり、設計の最初程度で。
実際のプログラムの細かい設計までには使わなそう。

Miro とかで書いた方が早かったりはするんだろうけど、ドキュメント自体が Miro で完結することは少ないから、ある程度テキストベースに寄せておいた方がいいのかなぁと。
見た目のわかりやすさは悩ましいところだけど。
かといって Miro でキレイにわかりやすい図が書けるのか?というと自分のセンス的に難しい。

であれば最低限の情報をわかりやすく伝えるための、テキストを補足する図として使ってみるかな、というところ。