要件定義をGeminiやVSCodeの拡張機能を用いて,効率よく図示する手順
プログラム開発において,要件定義書が重要であることは分かっていても,書くのが面倒でついついサボってしまう.
そんな時に,効率よくクラス図を書くための手順を紹介します.
1.準備 ①: VSCodeの拡張機能のインストール
1.VSCodeを開き,左側のサイドバーにある拡張機能アイコン(四角が4つ並んだアイコン)をクリックする.
2.検索ボックスに「PlantUML」と入力する.
3.PlantUML拡張機能(作者: Jebbs)が表示されたら,インストールボタンをクリックしてインストールする.
2.準備 ②: Java Development Kit (JDK)のインストール
PlantUMLのレンダリングにはJava環境が必要.
1.Oracle JDK,OpenJDKなど、任意のJDKをダウンロードしてインストールする.
2.インストール後,コマンドプロンプトやターミナルでjava -versionと入力し,バージョン情報が表示されることを確認する.
3.準備 ③: Graphvizのインストール
1.Graphvizの公式サイトから,OSに合ったインストーラーをダウンロードしてインストールする.
pip install graphviz
2.インストール後,環境変数PATHにGraphvizのインストールディレクトリが追加されているか確認する.
dot -V
4.要件定義の自動作成とその表示
1.Geminiなどを用いて要件定義を記述してもらう.
(例)
電動自動フォークリフトのシステム構成が分かる要件定義をUMLのテキスト形式(PlantUML記法)で示して.
とすると,Geminiから回答されたスクリプトをVSCode上の新規ファイルへペーストして,Auto_Forklift.pumlというファイルとして保存する.
2.VSCodeメニュー>表示>コマンドパレット(Shift+コマンド+P)で
検索ウィンドウにpと入力するとPlantUML:ファイル内のダイアグラムをエクスポートが現れるので,それを選択すると,以下のファイル形式がポップアップするので,任意のフォーマット(今回は,pngを選択)で,カレントディレクトリの下にoutというフォルダが自動生成されて,その下にファイルとして保存される.
ここでは,電動フォークリフトの自動化ソフトウェアを開発することを例に挙げて,要件定義をAIと壁打ちして,作成してみたものを参考までに表示する.
(内容そのものよりも,VSCodeの拡張機能PlantUMLを用いて要件定義がどのように表示することができるのかを見て下さい)