2024/12/8 PlantUML のはなし

わたしのTIL Advent Calendar 2024 - Adventar 8日目

作図していますか？わたしはよく作図しています

チームに考えを共有したい場面

コンポーネント間の協調やデータの移動をどう実施するのかのシーケンス

問い合わせがあった場合に、ステークホルダーに理解してもらうためのフローチャート

PlantUMLに限らず、ユースケース駆動開発実践ガイド (書籍のメインはロバストネス図やモデリング図ですが) を読んでから、コミュニケーション手段のひとつとして、情報整理の手段として、自分の頭の中の整理として、けっこう作図するようになりました

今日は PlantUML の豆テクを一つ書いて終わりにします

シーケンスを書いているときに、note を書くんだけど、情報が薄くて表組みを書けないかなと思ってたまたま | を使って表組みっぽいテキストを書いてみたら、PlantUML に用意があったという話です

code:seq.ml

@startuml

Alice -> Bob: Authentication Request

Bob --> Alice: Authentication Response

note right

|table-header1|h2|h3|

|table-cell1|c2|c3|

end note

Alice -> Bob: Another authentication Request

Alice <-- Bob: Another authentication Response

@enduml

こういった記述がこうなる

https://www.planttext.com/api/plantuml/png/XOzB2W8n343tEKKkqCMCEn6PyGZUeDC9fb1RRTDT3c_yW203RbzUoClKn5VfrmHpYe7G7V5KbZtENPYonE0bbendkdTg0ZP3PyvBth3QhUH60Ba8OOqN5a1KyKiYn-HNgeFogBpJBm-Kqg1Xr62KyehFPVZjCSXKqMztlUM3St_iJzzaP-pd1m00#.png

ニッチなので使う場面があるかどうかわからない、ちょっと微妙なテクの紹介でした

ちなみに Cosense で PlantUML の結果 (not コード) を表示したい場合は、https://www.plantuml.com/plantuml/ で作図しシェアできる URL の末尾に #.png などのsuffixをつけると表示できます

今日は以上です