MarkdownとPlantUMLでソフトウェアの仕様書や設計書を書いてみる
1.PlantUMLとは？
PlantUMLはUMLダイアグラム作成用のテキストベースの言語で、シーケンス図やユースケース図や状態遷移図（ステートマシン図）といったダイアグラムを作成することが可能です。
PlantUMLでユースケース図を作成する機会がありましたので、ざっくりと作り方をご紹介します。
まずは、VS Code上でPlantUMLを記述できるようにするために、インストールを行いましょう。
● Javaをインストール
● PlantUMLをインストール（今回のメイン）
● Graphvizをインストール（図の描画に使用しているソフト）
2.VS Codeで動くようにする
● VS Code で PlantUML を書くためのプラグイン
● Alt + d でプレビュー表示
● .puの拡張子で保存する
VS Codeでマークダウン内のUMLを動作させるための設定を行いましょう。
● Markdown Preview Enhanced
・Markdown 中の PlantUML をプレビューできるようにするプラグインで、Ctrl + k, v でプレビューが表示される
・または右クリックからMarkdown Preview Enhancedを選択する
・.mdの拡張子で保存する
シーケンス図は主に横に進む時間軸を表現するために使用されます。
オブジェクトの複雑なアクションやページの遷移フローなどを構築するのに適しています。
ユースケース図でも問題はありませんが、リクエストとレスポンスが時間軸内に存在する場合は、おそらくシーケンス図の方が適していると思われます。
書き方はさまざまな方法がありますので、公式ドキュメントを参考にしてください。
今回の使用経験から、メリットとデメリットがあることを感じました。
エンジニアチームでの運用には良い選択肢だと思いますが、最近のデザインツールは非デザイナーでも簡単に扱える時代になっているため、検討すべき点です。
以下に主なメリットとデメリットを示します。
3.メリット
● コードベースで管理できるため、バージョン管理しやすい。
● フォーマットが決まっているのでチーム開発で人によって作り方が大きく違うなどが起こりにくい。
4.デメリット
● 固有の書き方に慣れないといけない。
● デザインツールを簡単に使える人は逆に効率が落ちる。
複雑なことをしようとすると、途端に難しく感じるので、正直なところMiroで十分ではないかと思っています。
それでは。