PlantUMLでの開発要件整理

こんばんは。瑞田多理です。

突然ですが「神エクセル」ってご存知ですか。ご存知なければ結構、あなたは幸いな人です。ご存知の方はご愁傷様です。心中お察しします。

エクセルは表計算ソフトですが、IT屋の界隈ではなぜか（本当に、IT屋なのになぜか）ドキュメント作成ソフトとして使用されがちです。セルの大きさが自由に変えられるので、セルを正方形にすればインデントや改行をシステマティックに表現できるからです。画像も貼れるし、文字色の変更も自由です。便利なソフトですね。汎用性は正義です。

でもエクセルはベターな選択ではありません。（根本的な用途の誤りに目を瞑ったとしても）いろいろ理由はありますが、一番大きいと個人的に思っているのが「バージョン差分がわかりづらい」というところだと思っています。

この欠点は目まぐるしい勢いで仕様が変わる・更新される設計フェーズでは致命的なものになります。要求との紐付けが本当に難しい。中間を繋ぐ新たな表が必要になります。表が増えるということは更新するべき箇所が増えるということで、その分だけ更新漏れの確率が上がります。それを防ぐためにチェック機構を整えて、ギスギスして……という現場が実に多いことを痛感している今日この頃です。

そろそろタイトルの話に移ります。PlantUMLというおもちゃの情報を得たので今晩遊んでいました。楽しかったです。ドキュメント管理にも使えそうです。

https://plantuml.com/ja/

PlantUMLは「テキストエディタ」で「UML（ざっくりいうと要件定義のための図）」を書くためのソフトです。何言ってんだこいつ、って感じですが百聞は一見にしかず。こういう感じで書けます。開発予定の「気まぐれノベル」機能をシーケンス図に起こして試してみました。

テキストで書けるということは、Gitで差分がすぐにわかります。つまり何を編集したのかが一目瞭然で、かつGitのコミットメッセージで要求のバージョンとの紐付けもできるということです。シーケンス図の画像を直接、版管理の表を作るなどして管理するよりも、よりわかりやすいと言えます。多少ルールや記法の学習コストはあるにしろ、エクセルの運用ルールを決める手間に比べればなんということはないですね。

肝心の書きやすさについてはまだ検証中ですが、シーケンス図に限って言えばかなり直感的にサクサク書けます。これから設計が進むにつれてクラス図とか書くことになると思うので、そのときにまたご報告しますね。

それでは、今日はこの辺で。

全ての神エクセルに祈りを捧げつつ、眠りましょう。