目次
- 目次
- はじめ
- Markdownで書くメリット
- Markdown記法一覧
- 環境構築手順
- 1. Visual Studio Codeをインストールする
- 2. PlantUMLをインストールする
- 3. Javaをインストールする
- 4. Graphvizをインストールする
- 5. Markdown Preview Enhancedをインストールする
- 環境構築後の動作確認
- Markdownでドキュメントを書く際に便利な拡張機能
- 1. Paste Image
- 2. markdown-index
- 作成したドキュメントをHTMLやPDFに変換する
- 今回参考にさせていただいた記事
はじめ
自分はこれまでソフトウェア開発において仕様書や設計書を作成する際、Enterprise ArchitectというGUIで操作するソフトウェア設計支援ツールを用いてUML図を描いてきました。
必要なコンポーネントをドラッグアンドドロップするだけでUML図を作成できるので簡単なのですが、図のレイアウトは自分の手で微調整しなければならないので少々面倒です。また、それらの図を挿入する先のドキュメント本体はWordやExcelで作成するのですが、ドキュメント本体もUML図も同じ環境で一度に作成する方法はないかと思っていました。
今回いろいろ調べたところ、自分が愛用するエディタであるVisual Studio Codeであれば、Markdownでドキュメントを書くのとUML図の作成を一度にできるということを知ったので、その方法についてメモしておこうと思います。