PlantUMLを使ってみる
PlantUMLを使ってみる ドキュメントを作るとき、図も文章やコードと同じようにGitで差分管理できると嬉しいなぁ、と思っていました。 そこへテキストベースで各種UML図が作成できる、 PlantUML なるものがあると後輩に教えてもらったので、少し試してみることにしました。 (UMLも勉強したことなかったので、ちょうどいいやと) 環境 VSCodeにPlantUML Extensionを導入 VSCodeから、 PlantUMLのExtension をインストールします。 これだけだと動作しないので、追加でツールのインストールが必要です。 Windowsの場合、Extensionの Quick Install for Windows の項目に書いてある通り、Chocolateyで PlantUMLのパッケージ をインストールするのが簡単でした。 試してみたこと 今回は「カレーをつくる」ことをざっくり他の誰かに説明したい、という場合を考えました。 説明に必要な要素はこんな感じだと思います。 どんな道具や設備があるのか 1.で何をするのか 2.によって何が得られるのか 1-3をどのような手順で行うのか シーケンス図 を使えば説明できそうですが、 道具や設備をいつから片付けられそうか 道具や設備でやることのすべて は「ざっくり」という今回の目的からすると不要な気がしたので、もう少し見やすい(見やすそうな) コミュニケーション図 を使ってみることにします。 コミュニケーション図(?)を描いてみる 自分はチキンラーメンにお湯を注ぐくらいしか料理できないですが、自分の想像を説明する体で作ってみました。 PlantUMLのコードは以下の通りです。 @startuml title カレーをつくる '要素 actor Me agent 冷蔵庫 agent シンク agent コンロ agent 炊飯器 '要素間のコミュニケーション Me -up->> 炊飯器 : 1. ご飯を炊く 炊飯器 .down.>> Me : ご飯 Me -left-> 冷蔵庫 : 2. 肉と野菜取り出し 冷蔵庫 .right.> Me : 肉と野菜 Me -down...