こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
Markdownは便利な記法ですが、標準ではごく基本的な構文しか提供していません。そのため、多くの開発者によって様々な拡張が行われています。システム設計を行う際に使われるUMLを描画したいというニーズがその一つです。
今回はMarkdownの中にUMLを埋め込めるエディタを紹介します。Webベース、GUIそしてWebサービスとカテゴリごとに紹介しますので、あなたにとって最適なMarkdown環境を選んでください。
目次
GUI エディタ
Boost Note
Boost NoteではPlantUMLを使ったUML描画が可能です。日本語はエラーになるようです。
Boost Note is a powerful, lightspeed collaborative workspace for developer teams
Typora
Typoraはjs-sequence/flowchart.js/mermaidに対応していますが、PlantUMLは利用できないようです。
Typora — a markdown editor, markdown reader.
Mark Text
Mark TextはFlowchart/Sequence diagram/ガントチャート/Vegaチャートに対応しています。これらを使うことで、一部のUMLが利用できます。
エディタプラグイン
Markdown Preview Enhanced
Markdown Preview EnhancedはAtom、Visual Studio Codeの両方にプラグインを提供しています。PlantUMLをはじめ、Flow Chartsやjs-sequence-diagrams、Mermaid、WaveDromなどのライブラリを利用できます。
日本語も利用可能です。
Webサービス
NotePM
NotePM（ノートピーエム） は、ナレッジ共有に特化した「社内版ウィキペディア」です。検索に強く、情報を整理しやすいのが特徴です。NotePMでは uml を使ってPlantUMLによる描画が可能です。
日本語も利用できます。
NotePM – テレワーク時代のナレッジ共有ツール (社内wiki)
StackEdit
StackEditはUMLは対応しておらず、Mermaidを使ったドローに対応しています。Mermaidを使えばクラス図やシーケンス図は作成できます。
HackMD
HackMDは plantuml でPlantUML、mermaid でMermaidによるドローに対応しています。
esa
esaは uml によるPlantUML、 mermaid によるMermaid描画が可能です。
日本語も対応しています。
DocBase
DocBaseは plantuml によるPlantUML、 mermaid によるMermaid描画が可能です。
日本語も可能です。
Kibela
Kibelaは plantuml によってPlantUMLが埋め込めます。
GROWI
GROWIは “` が不要で、いきなりPlantUMLを描画できます（ただし日本語は使えないようです）。また、blockdiagにも対応しています。
以下はblockdiagのatcdiagの例です。
まとめ
UMLをテキストベースで書ければ、システム変更に伴う修正も容易に行えます。テキストで仕様を書くよりも伝わりやすく、システム理解にもつながります。また、検索も容易なので、必要な情報を探すのにも一役買うことでしょう。社内の知識を共有するのに役立つはずです。
ぜひ今回紹介したソフトウェア、サービスを皆さんのシステム開発にご利用ください。
NotePM（ノートピーエム） は、Webで簡単にマニュアル作成できて、強力な検索機能でほしい情報をすぐに見つけられるサービスです。さまざまな業界業種に導入されている人気サービスで、大手IT製品レビューサイトでは、とくに『使いやすいさ・導入しやすさ』を高く評価されています。
NotePMの特徴
- マニュアル作成、バージョン管理、社外メンバー共有
- 強力な検索機能。PDFやExcelの中身も全文検索
- 社内FAQ・質問箱・社内ポータルとしても活用できる
- 銀行、大学も導入している高度なセキュリティ。安全に情報共有できる
URL: https://notepm.jp/
