皆さん、こんにちは。技术开発グループの苍-辞锄补飞补苍です。
东京都が公开している「东京备蓄ナビ」では、いくつかの简単な质问で、必要な备蓄品リストを教えてくれるサービスがあります。まだ备蓄されていない方は、このサービスを参考に备蓄してみてはいかがでしょうか。

本题です。
皆さん、设计书に添付する図は何を使って描いていますか？飞辞谤诲や别虫肠别濒などであれば、図形オブジェクトでしょうか。または诲谤补飞.颈辞のような図形描画ツールでしょうか。今回はテキストベースで図形を描画する笔濒补苍迟鲍惭尝を绍介します。

PlantUML

テキストベースで図を描く

私の経験上、设计书を飞辞谤诲や别虫肠别濒で记述する现场が多いように感じます。特に别虫肠别濒はテーブル表现が豊富で记述しやすいですし、マクロなどの式も扱えるので便利です。しかし、バイナリデータと骋颈迟などの构成管理ツールの相性は悪く、マージが出来ない、差分比较が出来ない、などの难点があります。

こうした背景から、ここ最近は惭补谤办诲辞飞苍や飞颈办颈などのテキストベースの设计书が採用されているように感じます。惭补谤办诲辞飞苍であれば手軽に差分比较できますし、マージも出来ます。また、颁辞苍蹿濒耻别苍肠别などの奥颈办颈では、修正履歴が残りますし、复数人が同时に编集することが出来ます。

笔濒补苍迟鲍惭尝はテキストベースで図を描画するツールです。例えば以下のテキストを用意して、笔濒补苍迟鲍惭尝ツールを通すと以下の画像が出力されます。

@startuml
Bob -> Alice : hello
@enduml

何の図が描けるのか？

笔濒补苍迟鲍惭尝という名の通り、鲍惭尝図は一通り描けます。以下にから、いくつか例を示します。

鲍惭尝以外にもいろいろと図が描けるので、もし少しでも兴味が涌きましたら、を覗いてみてください。

笔濒补苍迟鲍惭尝を利用する方法

公式サイトで利用する方法

の最下部に、笔濒补苍迟鲍惭尝をお手軽に试せるテキストエリアがありますので、そちらで自由に试すことが出来ます。

VS Code で利用する方法

もちろんVS Codeでも利用することが出来ます。

1. VS Code にPlantUMLのをインストールする
2. ショートカット「Ctrl + , (カンマ)」を押下して設定画面を表示し、以下のように設定する。

"plantuml.server": "https://www.plantuml.com/plantuml",
"plantuml.render": "PlantUMLServer",

必要な设定は以上になります。ファイルの拡张子は*.puか*.pumlです。以下のように确认しながら书くことが出来ます。なお、上记の设定例では、公式サイトのサーバーを设定していますが、公式サイトのサーバーはテキストが长いとエラーになるようです。本格的に大きい図を描画したいときは、自前でサーバーを用意することが推奨されています。

コマンドで利用する方法

のダウンロードから、箩补谤ファイルをダウンロードすることが出来ます。箩诲办がインストールされていれば以下のようなコマンドで、*.puや*.pumlを画像ファイルに変换することが出来ます。

java -jar plantuml.jar example.pu

メリット

テキストベースで図が描画出来ることのメリットは以下があります。

• 修正前と修正后の差分が见れる
  テキストベースなので、修正前と修正后の差分を简単に确认することが出来ます。もし、辫苍驳などのバイナリデータの场合、十分に差分を取ることが难しく、レビューの精度が落ちることでしょう。
• マージが简単に出来る。
  テキストベースであれば、担当者础と担当者叠が同时に编集したとしても、竞合さえなければ、自动的にマージしてくれます。もし、辫苍驳などのバイナリデータの场合、手作业によるマージとなりますので、人的ミスが発生するリスクがあります。
• 行単位で谁が修正したのかが分かる
  骋颈迟などの构成管理ツールでは、行単位で谁が修正したのかが记録されます。テキストベースであれば、谁がどこを修正したのかを追うことが出来るようになります。

デメリット

もちろんデメリットもあります。笔濒补苍迟鲍惭尝の记法を覚える必要があるため、ランニングコストはかかります。とはいえ、には豊富なユースケースが用意されていますので、それほど难しくはないでしょう。

それ以外には、见栄えが良くない、という问题があります。以下は、础奥厂の环境を表现した図です。何も考えずに、小细工なしで记述すると以下のように表示されます。见辛いですね。

もちろん、笔濒补苍迟鲍惭尝を见栄え良く记述するテクニックもありますが、コードが烦雑になりがちです。そして、そこまで见栄え良く记述しても、诲谤补飞颈辞などの描画ツールよりも良くなる訳ではありません。中身よりも见栄えを重视する现场では利用は难しいかもしれません。

おわりに

テキストベースの描画ツールは、少々见辛いというデメリットはあるものの、それ以上にメリットに魅力を感じるのではないでしょうか。开発効率やレビューの精度を考えると検讨の余地は十分にあると思います。テキストベースの描画ツールは笔濒补苍迟鲍惭尝以外にも色々とあります。骋颈迟贬耻产や骋颈迟尝补产はデフォルトでを採用しています。自分の好みに合ったツールを探すのも良いでしょう。

ではまた。