メインコンテンツまでスキップ

generate-usecase-diagram

要件文または既存のMermaidから、アクターとシステムの機能を示すユースケース図を作ります。編集できるMermaid原本とPNGを保存し、複数の図を一覧・拡大・取得できるHTMLカタログにまとめます。HTMLと画像は相対パスでつながるため、出力ディレクトリを渡すとサーバーなしで閲覧できます。

シーケンス・ER・状態遷移を表す場合はarchify-jpを使います。このスキルではMermaidの専用構文usecase-betaを使い、役割と機能の関係を表します。公式構文

依頼例​

注文システムのユースケース図をMermaidとPNGで作り、HTMLカタログにしてください。
会員は注文できます。注文時の支払いは必須です。
会員が希望した場合、クーポン適用を注文に追加します。
運用担当は注文を一覧でき、管理者は運用担当の操作を引き継いで注文を取り消せます。
会員向けと運用向けの2枚に分けてください。カタログ名はorderです。

既存原本がある場合は、.mmdファイルの場所とカタログ名を指定します。入力にない認証・支払い・権限の機能は追加しません。include・extend・汎化には、必須処理・条件付き追加・継承する役割や機能の根拠が必要です。

進め方​

  1. 対象システム、アクター、機能、関係を入力から整理します。判断に必要な材料がなければ確認します。
  2. 要件からMermaidを作るか、既存原本を指定します。構文解析で宣言・境界・関係を確かめます。
  3. 全図をPNGへ変換し、アクターと境界を原本から取得してカタログへ反映します。
  4. 原本・PNG・HTML・変換記録の対応を検査し、実画像とカタログの操作を確認します。
  5. 全図が成功した後に出力を確定します。更新の依頼がある場合だけ既存カタログを置換します。

出力先はartifacts/usecase/<catalog-name>/です。index.html、catalog.json、validation.jsonと、diagrams/内のMermaid・PNGを一緒に保管してください。1図の場合も同じ構成になります。

生成にはPython 3.9以上、既存のMermaid 12完全版、Chromeが必要です。スクリプトはパッケージを自動導入しません。標準の探索で見つからない場合はUSECASE_MERMAID_JSとUSECASE_CHROMEで場所を指定します。描画はPOSIX向けで、Windowsは未対応です。閲覧時にはMermaidもChromeの描画処理も不要です。

このスキルはskill-foundationで作成し、決定表、出力契約、違反例、検査スクリプト、Claude Code・Codex用hooksを同梱しています。hooksとまとめて配布する単位はpluginと判断しています。今回の対応範囲はスキル正本とガイド・実行例の追加で、専用pluginの配布物作成・公開・利用環境への導入は含みません。installとhooksの検証は隔離した作業用プロジェクトで行います。

成果物の例​

図書館の貸出と蔵書管理を2図に分け、必須の資格確認・希望時の貸出票・主任司書の役割継承を表すMermaid・PNG・HTMLを新規生成しました。

到達点:新規生成・PNGと実画面の目視・HTML操作・check・finish・ZIP照合まで完了。利用者の最終確認と製品内hooks自動発火は未実施。。

実行した依頼​

図書館システムのユースケース図をMermaid原本・PNG・HTMLカタログで作ってください。カタログ名はlibrary、機能範囲別に次の2枚に分けます。
1. 貸出:利用者は本を借りる。司書も利用者に代わって本を貸し出せる。本の貸出には貸出資格の確認が必須である。利用者が希望した場合にだけ、貸出票の発行を貸出に追加する。
2. 蔵書管理:司書は本を登録できる。主任司書は司書の操作を引き継ぎ、本を除籍できる。
要件にない機能を追加せず、日本語ラベル、include・extend・汎化の向きを確認してください。

実際の画面​

図書館の貸出と蔵書管理を2図に分け、必須の資格確認・希望時の貸出票・主任司書の役割継承を表すMermaid・PNG・HTMLを新規生成しました。

画像を原寸で開く

新規生成したカタログの実画面を保存し、画像を開いて確認しました。利用者の最終確認は未実施です。

実出力の抜粋​

以下は保存した原本の冒頭です。全文は原本から取得できます。

最終の返答は、次の本文をそのまま使う。前後に文を足さず、要約しない。
========================================
## 結果

generate-usecase-diagram: 完了(検証に合格)

## カタログ

- [HTMLを開く](/private/tmp/context-model-refresh/generate-usecase-diagram/project/artifacts/usecase/library/index.html)
- 図: 2枚。原本・PNG・HTML・変換記録の対応を検査済み。
- 目視: reviewed

## 出力

- `artifacts/usecase/library/catalog.json`(catalog カタログ情報)
- `artifacts/usecase/library/index.html`(html HTMLカタログ)

成果物を取得する​

確認した結果​

  • preflight・start・build・preview・review・check・finish を実行し、指摘0件で終了。
  • 全2枚のPNGとpreview実画面を開き、日本語・境界・関係線を目視。includeは必須資格確認へ、extendは追加の貸出票から貸出へ、汎化は主任司書から司書への向きを確認。
  • Chrome自動操作で一覧2枚・画像妥当性・検索0件・拡大と閉じる・原本表示・取得リンク6本・相対リンク・横はみ出しなしを確認。保存先への実ダウンロードは今回未検証。
  • 公開前に個人ホーム名と実環境の詳細版をマスク。ZIP全件の展開内容が公開ファイルとbyte一致。正本全体は実行前後で不変。
  • マスク後の公開カタログを正本catalog.pyのcheck/verifyで再検査し合格。

確認するポイント​

  • アクター・機能・include・extend・汎化が入力の要件と一致しているか。
  • 日本語ラベルが読め、境界や関係線に欠け・重なりがないか。
  • 一覧・検索・PNG拡大・原本表示が使え、同じカードからPNGと原本を取得できるか。
  • validation.jsonが全図の成功を示し、原本と画像の対応を検査できるか。未実施の目視や利用者の承認を確認済みとしていないか。

PNGの破損とファイルの不一致は機械で検査できます。要件と図の意味が一致するかは、原本と入力を照合して判断します。

正本を読む​

詳細な手順と契約はgenerate-usecase-diagramのSKILL.mdを参照してください。作成方針はIssue #85の承認済み計画に記録しています。