Loom
システムの「構成」と処理の「流れ」を左右に並べ、一歩ずつ進めながら説明できる可視化ツールです。
これは何か
Loom は、システムの説明に使う図を「構成」と「流れ」の2つに分けて、同じ画面に並べて見せるツールです。
左に処理の流れ、右にシステムの構成図を置きます。流れを一歩進めると、その処理が触れている部品が構成図の上で光ります。どの順番で、どこが動くのかを、1枚の画面で追えます。
なぜつくったか
システムの構成図は、1枚にまとめようとすると線が増えて読めなくなります。かといって流れ図だけでは、どの部品の話をしているのかが伝わりません。
そこで、構成図は動かさずに置いておき、流れのほうを紙芝居のように一歩ずつ進める形にしました。経緯は note の記事「構成図が1枚にまとまらなくて、紙芝居だと思ったら解けた」に書いています。
画面の見方
| 場所 | 表示するもの | 役割 |
|---|---|---|
| 左 | 処理の流れ(タスクとそのつながり) | 時間の順番を示す |
| 右 | システムの構成(部品とそのつながり) | どこに何があるかを示す |
| 下 | 操作バーと、いまのタスクの説明 | 戻る・進む・分岐の選択・自動再生 |
流れの途中に分岐があるときは、下のバーで進む先を選びます。並行して進む処理、人の確認を待つ箇所、前の手順に戻るループも表せます。
使い方
- Loom を開きます。
- 「サンプルを読み込む」を押すと、用意してある例がすぐに表示されます。
- 自分のシステムを見せたいときは、決まった形の JSON ファイルを用意して「JSONをアップロード」から読み込みます。
JSON には、構成(部品とつながり)と、流れ(タスクとつながり)の2つを書きます。各タスクに「主に動く部品」と「入力・出力として触れる部品」を書いておくと、そのタスクに来たときに構成図の該当箇所が光ります。
技術構成
| 項目 | 使っているもの |
|---|---|
| 画面 | React |
| 図の描画 | React Flow(@xyflow/react) |
| 図の自動配置 | dagre |
| ビルド | Vite |
今後
使ってみた感想や、分かりにくかったところがあれば、お問い合わせから教えてください。
感想や質問をお待ちしています
使ってみた感想、ここが分かりにくいといった指摘、似たものをつくっている方の話など、何でも歓迎です。