Halcyon Days

IT × 移住 × ファイナンス

MENU

ドキュメントライティングのためにPlantUMLを使いこなすーマインドマップの書き方

なぜマインドマップを使うのか?

自分はマルチタスクがこの上なく苦手、かつ知覚推理の知能数が一般より低め(WAIS-Ⅳ 85)なので視覚情報を理解しにくかったり、自分の考えをまとめられなかったりするからです。

日本語であればまだわかるのですが、プログラミング言語だと何が何だかわからないことがたくさん。

事務作業を自動化するためのスクリプトのような上から下に流れていくものはまだいいのですが、複雑に組み込まれたシステムだったり、複数ファイルにまたがっているものはわからないことが多いのです。

ただ今はご縁にめぐまれてシステムエンジニアとして現場でコードを書かせていただいているのでどうにかできるようになりたい。

だましだましやってきましたが、どうやら自分の頭では限界がきたみたいです。

そのためにマインドマップを使って、自分の考えだったり、処理の流れだったりをメモとして残して、できるだけわかるようにしようと思いました。

対象読者

  • PlantUMLでマインドマップを書いてみたい人
  • 手軽に頭の整理をしたい人
  • VS Codeだけで作業を完結させたい人

多分、自分のような人だけではなく、考えの整理や要点のまとめなどにマインドマップは使えるので、ぜひ使えるようになっておくといいかもしれませんね。

書くこと

PlantUMLでのマインドマップの書き方を書いています。

詳しくはドキュメントを見ればわかりますが、自分がわかりやすいように補足をつけています。

マインドマップの効果や歴史、スタイリングなどは書きません。

PlantUMLでマインドマップを書く

OrgModeでの書き方とMarkdownでの書き方があります。

基本的な書き方

@startmindmap@endmindmap で囲まれた部分がマインドマップになります。

@startmindmap
    ' マインドマップのコンテンツ
@endmindmap

OrgMode

* を先頭につけて箱を作ります。

箱から枝を伸ばしたい場合には *の数を増やします。

@startmindmap
* root node
** child node
*** leaf node
*** leaf node
** child node
@endmindmap

Markdown

Markdown* を先頭につけて箱を作ります。

しかし、OrgModeと違って箱から枝を伸ばすにはインデントを下げます。

@startmindmap
* root node
  * child node
    * leaf node
    * leaf node
  * child node
@endmindmap

左右に枝を伸ばす

左右に枝を伸ばすには算術記号を使います。

+ が右側、 - が左側です。

@startmindmap
+ root node
++ child node
++ child node
+++ another child node
-- another child node
-- another child node
--- another child node
@endmindmap

複数行

:; を使うと箱の中に複数行を使うことができます。

@startmindmap
* root node
**:child node
This is a child node;
*** leaf node
*** leaf node
** child node
@endmindmap

箱を消す

_ を使うと箱を消せます。

@startmindmap
* root node
**:child node
This is a child node;
*** leaf node
*** leaf node
**_: child node
This is a child node;
***_ leaf node
@endmindmap

ただ、 +- を使う場合は注意が必要です。

+- を使いながら箱を消して複数行にしたい場合、 \n で改行をしなければなりません。

@startmindmap
+ root node
++ child node\nThis is a child node
+++ leaf node
+++ leaf node
--_ child node\nThis is a child node
---_ leaf node
@endmindmap

:; を使うと構文エラーになりました。

@startmindmap
' これはエラーになる
+ root node
++:child node
This is a child node;
+++ leaf node
+++ leaf node
--_: child node
This is a child node;
---_ leaf node
@endmindmap

おわりに

iThoughtsやmiroなどのツールを使っていましたが、いまいち使いこなせず、またタイピングだけでマインドマップを書けるのはいいなと思っています(マウス使うのが面倒なので)。

しかし、PlantUMLでマインドマップを書けるようになったので、いちいちアプリを切り替えることなく、かつタイピングだけで書けるようになってしまったのでめちゃくちゃ効率上がった気がしています。

あとは図のスタイリングや形の変更(上下方向など)などがありますが、ドキュメントがわかりやすいのでそちらを参考にいただければと!

自分のように凹があってもツール使えば何とかやっていけるって照明したいです!

やっていきましょ~~!