Markdownでシーケンス図とかが書けるMermaid記法で業務フローを書いたら意外とイケたので自分なりのコツを紹介してみる | DevelopersIO

こんにちは、臼田です。 みなさん、業務設計してますか？(挨拶 今回はMarkdownでシーケンス図やフローチャートなどの図を記述できるMermaidを使って業務フローを書いてみたら、意外と書けたので自分なりのTipsを紹介したいと思います。 その前に 注意点として、まだMermaidを使い始めたばかりなので、「もっとこうしたらいいぞ」とか「こっちのほうがいいぞ」とかあれば建設的なフィードバックとしてSNSとかでいただけるとありがたいです。 あと業務フローって表現しましたが、人によって思い描く業務フローが違うと思うので、業務フローの定義に関するツッコミはご容赦ください。私が今回Mermaidで書いたのは以下の図です。(内容はブログ用に簡素化しました) この図のコードは以下のとおりです。(後ほど解説します) sequenceDiagram autonumber actor お客様 partic

[kazuau]

仕様書とかワークフローとかって自分が書いたらそれで終わりってわけにはいかないことがほとんどだから、独自なツールはなかなか使えない。Office365で編集してTeamsで共有できるような形式にしておいてって言われがち。

[rrringress]

こういうの作るときが一番楽しい。使い道は知らん

[Phenomenon]

PlantUMLよりなんか見た目がイケてるよね。

[zkq]

Mermaidって本家のヘルプがわかりやすくて網羅性もあるのに、なぜ人は記事を書いてしまうのだろう。我々はそれを解明するためにアマゾンの奥地へと向かった…

[sbrtnpg]

業務フローをシーケンス図で書くのいいな。差分管理がしやすいのがいいよね。早速やってみる

[kekera]

こういう設計書は、図で確認したいわけではなく図で編集したい勢がいるので、記述→描画だけでは共有に向かないんよね。

[sechs]

plantUMLとの相互変換がないと今までの資産がーと言われがち。MSOfficeはそのへん最強なんだよね。

[arebouya]

markdownと版管理は情報リテラシーとして普及するべき。文書管理できてないところ多すぎ。

[ydf]

仕事だとastah professional版を毎年グループ全員分を買っているが、他部門にわたすときはPDF化している。

[agektmr]

JoplinというMarkdownのメモ帳アプリでもMermaidがインラインで記述できる。

[dekirukana_hate]

[[開発] [Mermaid] [記法] ]

[tolkine9999h]

改めて見ると凄い汎用性あるのね。今悩んてるやつこれで書いてみよう。

[teckl]

Mermaid記法、初めて書いてみたけどめっちゃ楽だった…Notionとの連携も最高（単にcacooなどが苦手なだけとも言う）

[xlc]

試しに状態遷移図を書いてみたらとても読める代物ではなかった。残念ながらExcelの作図はまだ手放せない。

[loveanime]

あくまで自分向けな感じもする

[yojik]

graviz/PlantUML より色々な意味で楽だし、GIthubが対応してくれたおかげで使える場面が広がったと思う。

[eerga]

officeで共有した場合の編集がやりづらいから、markdown+mermaid+gitにしている。(officeも慣れるときっと良いツール)

[isayo]

設計書をテキストでバージョン管理したいという思いvs直感的な書きやすさ(読みやすさ)／mermaidはjsなのでブラウザ(とかelectron)で動作するとこならどこでも動かせるのが強みね

[MtAsuka]

図は図としてWYSIWYGで書けてMarkdownなりテキスト形式でエクスポートできればいいだけでないの？わざわざ図をコードで書きたい気持ちがわからない。

[denden_engineer]

pythonでmermaid使いたい

[EngineerYtr]

githubで対応したならビューア不要にできるね

[tmatsuu]

わいわい

[securecat]

チーム内共有鑑みるとMiroのシーケンス図とかのほうがいいかな

[Andrion]

定期的にMermaid最高って話が出てくるけど、全関係者にアプリとMarkdownと記法を学ばせる手間を考えたら、MS Visioでも使った方が幸せになれる。

[reitanigawa]

マークダウンでシーケンス図。後で

[hirorinya]

おっしゃれー

[fashi]

構造図だからデザインは如何様にもできるのだろうけどこれは矢印小さくてちょっと読みにくいな

[strow0343]

可読性がイマイチなのでコメント入れてやりくりする感じになりそう。バージョン管理面は優秀だと思うけど

[perl-o-pal]

markdownはテキストで読みやすいのがいいのにビューワー必須なのって…って議論はもうケリがついているのかな。あんまり言ってると老害って言われそう。

[buhoho]

まあ良いんじゃない、便利ツール使うのは気晴らしにもなるし。チームでやるときはまた一つ覚える必要なツールが増えるので、ケースバイケースで合意とってから導入して欲しいけど

[remonoil]

GitLabでも```mermaidで使えるらしい。GW明けに試す

[ardarim]

見た感じPlantUMLとほぼコンパチなのか。

[nisend]

よさそう

[chiroruxx]

自分が書いたらそれで終わりじゃないからこそ、バージョン管理しやすい形式で書かないとね。みんな使っていこうぜで終わりだと思う。

[mrmt]

組織図や入退社フローの視覚化とかにも便利。mmdc使えば非対話処理もできる。