はじめに
今運用しているシステムのドキュメントの全てが、Officeで書かれています。 UMLまでパワポかエクセルで書かれており、管理が難しいと感じています。 そこでなにかいい方法・ツールが無いか調べて見ました。 すると図を生成するツールをまとめているものがあったので、共有しようと思います。
https://gist.github.com/hashrock/208b84c61558663e40bb
所感
紹介されているツールの中では、mermaid が使えそうでした。 mermaid では、シーケンス図だけではなくフローチャートやクラス図も生成できます。 （クラス図は Atom で試してみたらちゃんと生成できてませんでしたが….） また、生成した図は SVG か PNG で保存することができます。 Github で mermaid はサポートされていないので、画像で保存できる機能は必須ですね。 今後 Github でサポートしてもらいたいものです。
試しに
mermaid でサンプルとあげられてたグラフを生成してみました。 Atom へのインストールは、こちらを参照して下さい。
以下、リポジトリにあがっていたシーケンスの例です。
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts <br/>prevail...
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
生成した図は以下のようになります。
ちなみに、編集画面は以下のようなかんじです。
おわりに
今回調べたツールを導入してOfficeから脱却したいですね。
ツールまとめ
高橋克幸
新卒3年目で脱新人を目指してます。
フロントに興味を持ち始めた今日このごろ。
趣味は 麻雀 プログラミング 音楽。
運動不足を感じているため、ダンスを始めようかと思っています。
