Excelでフローチャート書くの辞めてmermaid.jsで書きます。

エクセルで図を書くのが嫌い

業務の整理や頭の中の整理目的でフローチャートとかをExcelで作ってたんですが、
もっと脳死して図を作成できるmermaid.jsを使ってみました。

mermaidって

mermaidはマークダウンで図を書けるようにしてくれるjsのライブラリです。

  ```mermaid
   flowchart TD;
   hoge-->huga;
　```

VsCodeなどのエディタ上でも使用可能、下記のリンク内の記述は古いので、書き方は公式を見ましょう。あくまで紹介です。

使ってみよう！VSCode+mermaid

使ってみて感じたメリット

• 処理の追加が楽
• 書く消費カロリーが少ない
• 脳死で書ける
• レイアウト調整がいらない
• GitLabで(ちゃんと)管理すれば仕様変更の差分も分かる
• 誰が作っても同じようになるから見やすいから統一性がある

目指せMarkDownで仕様書を管理

弊社は成果物(ソースコード)をGitLabで管理していますが
仕様に関しての資料は割となーなーなです。
システム概要の資料をmermaidで書いてリポジトリに入れておけば、プロジェクトにアサインした人や引き継いだ人が把握しやすいかと思います。

クラス図やシーケンス図など色んな図が作れるので、機能ごとに何かしらの図を残しておくのも良いかなと思います。

下に人が付いた時とかのレビューも楽になる気もするのでMarkDownで資料を残す文化を築いていきたいですね。

余談

A5:SQL Mk-2というDBツールもテーブル定義書をMarkDownで吐けるようになったので、何でもMarkDownの流行りがきつつあるのでしょうか。
テーブル定義書もMarkDownで吐いてプロジェクト（リポジトリ）にぶち込んでおこうと思います。
誰かが作った成果物を閲覧する際も、そういった資料(MarkDown形式のテーブル定義書,mermaidで書いた仕様)があれば理解の速度も上がると思うので効率が良さそうです。