DocusaurusにPlantUMLテーマを作った理由

生成AIが使えるところではどんどん活用していきたい
詳細設計を書く時もそう

だからPlantUMLテーマを作りました

Mermaidでも良いのだけど、デフォルトで図が大きいのとかユースケース図がないのが理由でPlantUMLを使いたかった。

ともかく、作ったサンプルはこちら

• 詳細設計書サンプル

PlantUMLを使うメリット

1. UMLを書く時もPlantUMLやMermaidを使えばすべてテキスト書き出せる 🎵
2. だからGitHubで管理できる
3. 生成AIで出力できる

上記のサンプルもChatGPTでだしてもらった。
プロンプトはこちら

markdown(mdx)形式で出力する詳細設計書のサンプルを作って
仕様は以下の通り
- バックエンド。gRPCを使用(connect-go)を想定
- 顧客一覧の閲覧
- mdxを出力する時の条件
  - 箇条書きはすべて `1.` 
  - 記号はすべて半角(`(` や `:`)`)
  - 章立て作成時の章番号は不要(つけない)
- 処理の順序
  - 認証
    - エラー判定。エラーがあれば処理抜け
  - パラメーターのバリでチェック
    - エラー判定。エラーがあれば処理抜け
  - DBで権限確認
    - DB selection
    - エラー判定。エラーがあれば処理抜け
  - DBから一覧の取得
    - パラメーターによる条件絞り
    - 一覧取得
  - Result形式に変換
  - クライアントへresult
- 設計書の書く順序
  - 概要(1, 2行程度の処理を説明)
  - 前提条件
  - CRUD - 今回は"R"のみ。参照しているテーブル名
  - パラメーター仕様
  - Result仕様
  - シーケンス図 - PlantUMLで記載。コードブロックは 「```pumld」、「```」で括る
  - 処理詳細 - テキストベース。認証やSQL Queryなど。`###` で書く

いや～ ほんとうに便利な世の中になりました。