34
Help us understand the problem. What are the problem?

More than 5 years have passed since last update.

posted at

Organization

plantuml と Google Document で設計書を描く

動機

ソフトウェア設計にUMLはつきもの。
ここで図と設計文書をどう描くか = UMLを描くエディタ・文書化するツールの組み合わせ がとても重要。
ベストプラクティスが未だ見つけられていない。

PlantUML

コードベースでUMLを描けるツール。JAVAでできてる。
http://ja.plantuml.com/

UMLを描くツールでは、VISIO、astah、Excel、PowerPointなど使ってきた。
が、コードで図が描けるという快適性が今のところ最強。

なので、plantimlを使いたい。

PlantUML Gizmo

https://chrome.google.com/webstore/detail/plantuml-gizmo/gkhhgpmifdpiagjagcbconfnnhkmomnp
GoogleDocs 上で plantuml のプレビュー、挿入を可能にするプラグイン。
GoogleDocsに挿すので、アカウントが共通ならブラウザまたいで使用可能(FireFox、Chromeで試した)。

なぜPlantUML Gizmoが良いか

基本的に設計文書としては、以下の要求がある。これらを満たせるのがスバラシイ。
- 文書+図がドキュメント内で閉じた方が読みやすい。図は別ファイル参照とかFackin
- 図を書き換える度に別なエディタで編集が手間。そもそも元ファイルが共有されてなくて編集できないなんてことも。
さらにpalntumlに関して
- plantumlのプレビューができる
- plantumlのテンプレが選べる
- 挿入済みの図を編集できる

できないこと

GoogleDocs だし、アドオンもPlantUMLのサイトにアクセスするのでオフラインでは使えない。
あと、GoogleDocsよく知らないけど、バージョン管理とかはできないのかな。

使い方

チュートリアルがある。
https://www.youtube.com/watch?v=sXshJ4BPJt8

導入

使用したいアカウントで
https://chrome.google.com/webstore/detail/plantuml-gizmo/gkhhgpmifdpiagjagcbconfnnhkmomnp
からアドオンをインストール。

使い方

Add-ons から Start を選択。
スクリーンショット 2016-03-12 15.36.47.png

テンプレが選べる。よくコマンドを忘れる自分にはかなり便利。

スクリーンショット 2016-03-12 15.38.50.png

編集中にプレビューされる

スクリーンショット 2016-03-12 15.40.48.png

書いたら、Insertでドキュメントに挿入。
図を選択してEdit Selected を選ぶと、編集もできる。

スクリーンショット 2016-03-12 15.42.03.png

plantuml自体のコマンド等は公式サイト参照。
http://plantuml.com/

まとめ

これで、設計文書内でUMLの編集ができるようになった。
まだざっくりとしか試していないので、運用してからの使用感等あったら追記したいと思います。

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Sign upLogin
34
Help us understand the problem. What are the problem?