作成日: 2026-05-25 | バージョン: 1.0
委託先エンジニアは必ずこのドキュメントを最初に読んでください。
「誰が・何のために・どう使うか」を理解することが、仕様の勘違いを防ぐ最善策です。
┌─────────────────────────────┐
│ Regalis Japan Group │
│ (クライアント&管理者) │
│ 代表: 井上幹太 │
└──────────────┬───────────────┘
│ 開発委託
┌──────────────▼───────────────┐
│ 委託先エンジニアチーム │
│ (本ドキュメントの読者) │
└──────────────┬───────────────┘
│ 開発・納品
┌──────────────▼───────────────┐
│ HackⅡ プラットフォーム │
└──┬─────────┬────────┬────────┘
│ │ │
┌───────────┘ ┌───────┘ ┌────┘
↓ ↓ ↓
[顧客(コンテンツ [AI事業者 [AIクローラー
提供者)] ] (Bot)]
HackⅡ導入企業 OpenAI等 自律的に動作
プロフィール:
代表・井上幹太。HackⅡの事業オーナー。技術的な実装より「事業が成長しているか」に関心がある。
このシステムに求めること:
主なユースケース:
| No | ユースケース | 操作 | システムの反応 |
|---|---|---|---|
| A-1 | 全顧客スコア一覧確認 | 管理者ダッシュボードを開く | 全サイトのAICS™平均スコア・グレード分布を表示 |
| A-2 | 収益サマリー確認 | 収益タブを開く | Pay per Crawl 月次収益・顧客別分配額を表示 |
| A-3 | 新規AIモデル検知 | アラートメール受信 | 未知User-Agentを検知。識別テーブルへの追加を検討 |
| A-4 | 顧客サポート | 顧客のサイトIDを検索 | その顧客のクロールログ・スコア・設定を閲覧 |
エンジニアへの注意点:
管理者ダッシュボードと顧客ダッシュボードは必ず分離してください。管理者は全顧客データを閲覧できますが、顧客は自社データのみ閲覧可能です。
プロフィール:
マーケティング担当者またはWebサイト運営担当者。技術的知識は普通レベル。「AI検索での露出を増やしたい」が動機でHackⅡを導入。コーディングは不要な設計が必須。
このシステムに求めること:
主なユースケース:
| No | ユースケース | 操作 | システムの反応 |
|---|---|---|---|
| B-1 | クロール状況確認 | ダッシュボード → 概要 | 今週のAIクロール数・モデル別グラフ表示 |
| B-2 | スコア確認 | ダッシュボード → AIパッチ | 記事別AICS™スコア・改善アクション一覧 |
| B-3 | クローラー制御 | 制御タブ → CCBotをスロットリング | ワンクリックで throttle 設定を適用 |
| B-4 | パッチ更新確認 | 更新履歴タブ | llms.txt の最終更新日時・スコア変化を確認 |
| B-5 | 収益確認(将来) | 収益タブ | 今月のPay per Crawl分配額を確認 |
| B-6 | タグ設置 | 設置手順ページ | コピペ可能なHTMLスニペットを表示 |
エンジニアへの注意点:
- UIの用語は技術用語を避けてください。「User-Agent」→「AIの種類」、「Crawl-delay」→「アクセス頻度の制限」のように言い換えを徹底する
- エラーメッセージも「403エラー」ではなく「このAIはブロックに設定されています」と表示する
- 設定変更後は必ず「この設定が反映されました」の確認UIを表示する
プロフィール:
AIモデルを開発する大企業のAPIチーム担当者。Pay per Crawlのスキームに参加している場合のみ関係する。技術リテラシーは高い。
このシステムに求めること:
主なユースケース:
| No | ユースケース | 操作 | システムの反応 |
|---|---|---|---|
| C-1 | APIキー取得 | ポータルにアカウント登録 | APIキー発行・利用規約同意 |
| C-2 | 使用量確認 | GET /billing/usage | 当月課金済みクロール数・金額を返す |
| C-3 | 請求書確認 | メール or ポータル | 月末に請求書PDF |
| C-4 | 異議申し立て | サポート問い合わせ | 課金ログを証跡として提示 |
エンジニアへの注意点:
Pay per Crawl は Phase 3 の実装。Phase 1・2では「AI事業者からのAPIキー付きアクセス」の技術的な受け口だけ準備し、実際の課金処理は後回しにすることも可能。
プロフィール:
本システムの開発・保守を担当する外部エンジニアチーム。フロント・バックエンド・インフラのロールが存在する。
このシステムに求めること(エンジニア視点):
主なユースケース(開発・保守業務):
| No | ユースケース | 操作 | システムの反応 |
|---|---|---|---|
| D-1 | ローカル開発環境構築 | README に従いセットアップ | Docker Compose で全依存関係が起動 |
| D-2 | 新規AIモデル追加 | 識別テーブルJSONに1行追加 | ゲートウェイが即座に新モデルを識別 |
| D-3 | バグ修正 | テストで再現 → 修正 → テスト | CI/CDが自動でテスト実行・デプロイ |
| D-4 | パフォーマンス問題調査 | Datadog APMで遅いクエリを特定 | スロークエリログ・トレースが確認できる |
| D-5 | 本番デプロイ | mainブランチにマージ | GitHub Actionsが自動デプロイ |
エンジニアへの注意点(クライアントからの依頼事項):
- テストを書いてください。 ユニットテストカバレッジ80%以上を契約に含める
- 技術的負債を作らないでください。 「とりあえず動く」実装を避け、6ヶ月後に自分以外のエンジニアが読めるコードを書く
- セキュリティレビューをしてください。 IPアドレスの生ログ保存禁止・APIキーの平文保存禁止は必須
| ユースケース | 頻度 | 重要度 | 実装優先度 |
|---|---|---|---|
| B-1 クロール状況確認 | 毎日 | 高 | Phase 1 |
| B-2 スコア確認 | 週次 | 高 | Phase 2 |
| A-2 収益サマリー確認 | 月次 | 高 | Phase 3 |
| B-3 クローラー制御 | 不定期 | 中 | Phase 2 |
| B-6 タグ設置 | 初回のみ | 高 | Phase 1 |
| C-2 AI事業者 使用量確認 | 月次 | 中 | Phase 3 |
| A-3 新規AIモデル検知 | 不定期 | 高 | Phase 1 |
委託先エンジニアが実装前に確認すること: