PlantUML を導入するのに適したケースとは
半年ほど PlantUML を触った感想をまとめています。
結論
以下のいずれかに当てはまる場合、PlantUML はプロジェクトの生産性を向上させます。
- 一人で利用する場合
- 少数精鋭、もしくは統制(教育)されたチームで共有したい場合
- 情報共有ツールがすでに浸透している場合
PlantUML が解決している課題
- UML を理解していなくてもそれっぽい図が書ける
- 誰が書いても体裁が揃う
- 検索が可能
- バージョン管理システムと合わせると履歴管理の生産性が向上する
PlantUML は「書く」こと、また適切なツールと併用することで「調べる」ことの生産性を向上させます。
PlantUML の課題
- 学習コスト
- 環境構築
学習コスト
最大の課題は学習コストです。
公式サイトから和訳されたリファレンスが PDF でダウンロードできますが、100ページを超えています。( 大変ありがたいことです。) また、先日話題に上がった Real World PlantUML を見て回るにしてもベストプラクティスに迷います。( 素晴らしいサイトです。)
その他によく参照するチートシート（記事）を記載します。
環境構築
環境構築については、情報共有ツールやエディター、ブラウザのプラグインなど充実してきています。PlantUMLサーバーも公式・非公式とも選択肢があります。これは昨年夏以降ほぼ解決したと言って良いのでは？とさえ感じています。
- 情報共有ツール
- エディター
- ブラウザ拡張
- サーバー
- オンラインエディター
gitbook etc...
PlantUML 以外の課題
- 個々人のスキル
- 円滑なコミュニケーション
- 文化・慣習・雰囲気
- 怠惰
- 置かれているステージ
- 最終的な成果・結果
etc
導入フローを検討してみる
PlantUML と向き合うポイント
- 頑張らない
- 気にしない
- 抱えている課題が PlantUML で解决できる課題かどうか見極める
