Skip to content

ユーザーマニュアル ドキュメント不足項目リスト

作成日: 2025-11-20 目的: サブモジュール(answer-io-standalone)の最新機能をユーザーマニュアルに反映するためのタスクリスト


📋 概要

このドキュメントは、Answer IOアプリケーション本体(answer-io-standalone)で実装済みだが、ユーザーマニュアル(docs.answer-io.jp)にまだ反映されていない機能をリスト化したものです。

各機能について、以下の情報を記載しています:

  • 参照元: サブモジュール内のドキュメント・ソースコード
  • 追加すべき内容: ユーザーマニュアルに書くべき具体的な項目
  • ファイル構成案: 新規作成または更新が必要なファイル
  • 実装チェックリスト: 担当者が確認しながら作業できるタスク一覧

🔴 優先度: 高

1. Google Analytics連携機能

📍 現状

  • ✅ 機能実装済み(両環境で有効化)
  • ✅ 技術ドキュメント作成済み
  • ✅ プレスリリース発行済み
  • ✅ ユーザーマニュアル作成済み(2025-11-20完了)
  • ⚠️ スクリーンショット未追加(要対応)

📚 参照元ドキュメント

主要ドキュメント:

  • answer-io-standalone/docs/google-analytics-integration.md - 技術仕様とAPI詳細
  • answer-io-standalone/docs/operations/ga-integration-production-deployment.md - 本番環境での有効化手順
  • answer-io-standalone/docs/press/フィードフォース、「Answer IO」にGoogle Analytics連携機能を追加、AI経由のサイト流入とブランドスコアを統合分析.md - プレスリリース

関連コミット:

  • 19e0ff70 - 両環境でGA連携機能を有効化
  • 0e452a2b - GA property管理機能の強化
  • 7ec64c1a - GAドキュメントの更新
  • 7029c10b - ステージング環境でGA連携を有効化

📝 ユーザーマニュアルに追加すべき内容

1. 概要ページ(新規作成)

ファイル: ja/getting-started/google-analytics.md

含めるべき内容:

markdown
# Google Analytics連携を設定する

## Google Analytics連携とは

- AI検索からのサイト流入を自動追跡
- 可視性スコアとWebトラフィックの相関分析
- ChatGPT、Perplexity、Gemini等からの流入検知
- ブランドスコアとビジネス成果の関連性を可視化

## 連携で得られるメリット

- AI検索経由の実際のトラフィックを測定
- ブランド可視性向上が実際の訪問者増加につながっているか確認
- AI別の流入パフォーマンス比較
- 施策の効果測定(スコア改善 → トラフィック増加)

## 設定方法

### 前提条件
- Google Analytics 4(GA4)プロパティが設定されていること
- GA4プロパティへの「閲覧者」権限以上があること

### ステップ1: ブランド設定ページを開く
(スクリーンショット推奨)

### ステップ2: Google Analytics連携を開始
1. ブランド詳細ページの「連携」セクションへ移動
2. 「Google Analyticsを連携」ボタンをクリック

### ステップ3: Googleアカウントで認証
1. ポップアップウィンドウが開きます
2. 「Googleでログイン」をクリック
3. Answer IOへの権限付与を承認

### ステップ4: GA4プロパティを選択
1. 連携可能なGA4プロパティの一覧が表示されます
2. 使用するプロパティを選択
3. 「保存」をクリック

### ステップ5: 初回データ同期
- 設定完了後、自動的にデータ同期が開始されます
- 過去30日分のデータが取得されます

## データの見方

### ブランド詳細ページでの表示
- AI検索からの流入数(セッション・ユーザー数)
- AI別の流入内訳
- 可視性スコアとの相関グラフ

### 指標の説明

**AIリファーラルセッション**
- ChatGPT、Perplexity、Geminiなどから流入したセッション数

**AIリファーラルユーザー**
- AI検索経由で訪問したユニークユーザー数

**コンバージョン**
- AI検索経由の訪問者が実行したコンバージョン数

## データ同期について

### 自動同期
- 初期設定後、過去30日分を自動取得
- 以降は手動で同期可能

### 手動同期の方法
1. ブランド詳細ページの「連携」セクション
2. 「データを同期」ボタンをクリック
3. 同期する期間を選択

### 同期頻度の推奨
- 週1回の定期同期を推奨
- レポート作成前の同期を推奨

## トラブルシューティング

### 「プロパティが見つかりません」
- GA4プロパティへの権限を確認してください
- 「閲覧者」以上の権限が必要です

### 「データが表示されません」
- AI検索からの流入には24-48時間かかる場合があります
- GA4でリファラー情報が正しく記録されているか確認してください

### 「接続エラー」
- 再度認証をやり直してください
- ブラウザのポップアップブロックを確認してください

## セキュリティとプライバシー

- OAuth 2.0による安全な認証
- Answer IOはGA4データを読み取るのみ(書き込み不可)
- 認証トークンは暗号化して保存
- いつでも連携解除可能

## よくある質問

**Q: Universal Analytics (UA) には対応していますか?**
A: いいえ、Google Analytics 4 (GA4) のみ対応しています。

**Q: 複数のGA4プロパティを連携できますか?**
A: 1ブランドにつき1つのGA4プロパティを連携できます。

**Q: データの取得上限はありますか?**
A: GA4のAPI制限(1日1万リクエスト)に準拠します。通常の使用では問題ありません。
2. 用語集への追加

ファイル: ja/glossary.md (既存ファイルに追記)

追加する用語:

markdown
## Google Analytics連携

Answer IOとGoogle Analytics 4(GA4)を接続し、AI検索からのサイト流入データを自動的に取得・分析する機能です。

### 主な機能

- **AI検索流入トラッキング**: ChatGPT、Perplexity、Geminiなどからの訪問を自動検知
- **相関分析**: 可視性スコアとWebトラフィックの関係性を可視化
- **コンバージョン測定**: AI検索経由の訪問者によるコンバージョンを追跡

### 対応指標

- **AIリファーラルセッション**: AI検索エンジンからの訪問セッション数
- **AIリファーラルユーザー**: AI検索経由のユニークユーザー数
- **コンバージョン**: AI検索経由で発生したコンバージョン数
- **バウンス率**: AI検索経由訪問者の直帰率
- **平均セッション時間**: AI検索経由訪問者の平均滞在時間

関連: [Google Analytics連携を設定する](/ja/getting-started/google-analytics)
3. はじめにページへの追加

ファイル: ja/getting-started/index.md (既存ファイルに追記)

推奨される学習順序に追加:

markdown
8. **[Google Analytics連携](/ja/getting-started/google-analytics)** - AI検索からのサイト流入を測定します(オプション)

✅ 実装チェックリスト

  • [x] ja/getting-started/google-analytics.md を新規作成 ✅ 完了 (2025-11-20)
    • [x] 機能概要セクション
    • [x] メリットセクション
    • [x] 設定方法(ステップバイステップ)
    • [x] データの見方セクション
    • [x] トラブルシューティングセクション
    • [x] FAQセクション
    • [ ] スクリーンショットの追加(少なくとも3枚)⚠️ 要対応
  • [x] ja/glossary.md に用語追加 ✅ 完了 (2025-11-20)
    • [x] Google Analytics連携の定義
    • [x] 主要指標の説明
  • [x] ja/getting-started/index.md に項目追加 ✅ 完了 (2025-11-20)
    • [x] 学習順序に追加
  • [x] ナビゲーション設定の更新 ✅ 完了 (2025-11-20)
    • [x] .vitepress/config.ts のサイドバーに追加
  • [x] レビューと公開 🔍 一部完了
    • [x] 内容の正確性確認(実装コードと照合済み)
    • [ ] スクリーンショットの品質確認 ⚠️ スクリーンショット未追加
    • [ ] リンク切れチェック ⚠️ 要確認

🔍 実装確認結果 (2025-11-20)

実装コードとの照合を完了しました。

確認したファイル
  • backend/app/api/v1/brand_analytics.py - APIエンドポイント
  • backend/app/db/models/brand_analytics.py - データベースモデル
  • backend/app/services/google_analytics.py - GA4連携ロジック
  • frontend/hooks/useAnalytics.ts - React Hooks
確認結果

✅ 正確性が確認された項目:

  • OAuth 2.0認証フロー(/oauth/authorize, /oauth/callback, /oauth/properties
  • 初回30日分のデータ取得(コード: start_date = end_date - timedelta(days=30)
  • AI検索エンジン8種類の検知(ChatGPT, Perplexity, Gemini, Claude, Copilot, You.com, Bing Chat, その他)
  • 取得指標6種類(sessions, totalUsers, screenPageViews, conversions, bounceRate, averageSessionDuration)
  • 暗号化保存(Fernet対称暗号化、環境変数 ENCRYPTION_KEY
  • トークン自動更新(アクセストークン期限切れ時)
  • リアルタイムデータ取得(GET /realtime-daily-metricsが主要API)

📝 ドキュメント修正内容:

  1. AI検索エンジンリストに You.com と Bing Chat を明記(8種類)
  2. データ同期の説明を「リアルタイム表示(推奨)」に更新
  3. 手動同期は「レガシー機能」として説明
  4. FAQセクションを実装に基づいて修正

⚠️ 残タスク:

  • スクリーンショットの追加(GA連携ボタン、認証画面、プロパティ選択、データ表示)
  • リンク切れチェック
  • ステージング環境での実機確認
データベーススキーマ詳細

brand_analytics_config テーブル:

  • ga_property_id (String 255) - GA4プロパティID
  • ga_property_name (String 255, nullable) - プロパティ表示名
  • auth_type (String 50) - 'oauth' or 'service_account'
  • credentials_encrypted (Text) - Fernet暗号化された認証情報
  • is_active (Boolean) - 有効/無効
  • last_synced_at (DateTime) - 最終同期日時(レガシー機能)
  • 1ブランド1設定のunique制約

brand_analytics_metrics テーブル:

  • 日次メトリクス保存(レガシー機能、現在は非推奨)
  • リアルタイムAPIが主流(DBを経由せずGA4から直接取得)

💡 作成時の注意点

  1. スクリーンショットは必須:

    • GA連携ボタンの位置
    • Google認証画面
    • プロパティ選択画面
    • データ表示画面
  2. 実際の画面遷移を確認:

    • ステージング環境で実際に操作して、手順が正確か確認
  3. エラーケースも記載:

    • よくあるエラーとその解決方法を含める
  4. 参照元ドキュメント:

    • answer-io-standalone/docs/google-analytics-integration.md の「Setup Guide」セクションを参考にする

2. CSVエクスポート機能

📍 現状

  • ✅ 機能実装済み
  • ✅ 技術ドキュメント作成済み
  • ✅ プレスリリース発行済み
  • ✅ ユーザーマニュアル作成済み(2025-11-20完了)
  • ⚠️ スクリーンショット未追加(要対応)

📚 参照元ドキュメント

主要ドキュメント:

  • answer-io-standalone/docs/features/report-raw-data-export.md - 実装計画書(詳細な仕様)
  • answer-io-standalone/docs/features/report-raw-data-export-analysis-guide.md - 分析ガイド
  • answer-io-standalone/docs/press/フィードフォース、「Answer IO」にCSVエクスポート機能を追加、レポートデータの自由な二次分析が可能に.md - プレスリリース

関連コミット:

  • 107fb4b4 - CSV エクスポート機能ドキュメント追加
  • 3079ae04 - レポートエクスポート機能ドキュメント追加
  • e94be29c - レポート生データエクスポートと分析ガイド
  • 358548a5 - CSVGenerator の後方互換性強化
  • 2bc933f1, 23fe8175, 48aeb84c - CSV エクスポートのバグ修正

📝 ユーザーマニュアルに追加すべき内容

1. 概要ページ(新規作成)

ファイル: ja/getting-started/csv-export.md

含めるべき内容:

markdown
# レポートデータをエクスポートする

## CSVエクスポートとは

レポート実行結果のすべてのデータをCSV形式でダウンロードできる機能です。エクスポートしたデータは、Excel、Google スプレッドシート、BIツールなどで自由に分析・加工できます。

## エクスポート機能のメリット

### Answer IO外での自由な分析
- 独自の集計方法でスコアを再計算
- 企業固有の指標を作成
- 複数レポートのデータを統合

### 既存ツールとの連携
- Excel・Google スプレッドシートで開ける
- Tableau、Looker Studio、Power BIにインポート
- 社内レポートフォーマットに統合

### 時系列分析
- 複数回のレポートデータを並べて推移を分析
- 季節性やトレンドを可視化
- 施策前後の比較

### データ保管とコンプライアンス
- 長期的なアーカイブ
- データウェアハウスへの保管
- 監査対応

## エクスポート方法

### ステップ1: レポート詳細ページを開く

1. 左サイドバーから「レポート」をクリック
2. エクスポートしたいレポート実行をクリック

### ステップ2: CSVエクスポートを実行

1. レポート詳細ページ右上の「CSVエクスポート」ボタンをクリック
2. ダウンロードが自動的に開始されます
3. ファイル名: `report_raw_data_{レポートID}_{日時}.csv`

### ステップ3: ファイルを開く

**Excelで開く場合**:
1. ダウンロードしたCSVファイルをダブルクリック
2. 文字化けする場合: Excelを起動 → 「データ」→「テキストから」→「UTF-8」を選択

**Google スプレッドシートで開く場合**:
1. Google ドライブを開く
2. 「新規」→「ファイルのアップロード」
3. CSVファイルを選択してアップロード

## エクスポートされるデータ

CSVファイルには以下の24カラムが含まれます:

### 基本情報ブロック(6カラム)

| カラム名 | 説明 |
|---------|------|
| レポート実行ID | レポート実行を識別するID |
| 実行日時 | レポートが実行された日時 |
| ファネル段階 | クエリのファネルステージ(認知・理解検討・決定行動) |
| クエリID | クエリを識別するID |
| クエリテキスト | 実行された質問文 |
| クエリタイプ | クエリの種類 |

### AI応答ブロック(3カラム)

| カラム名 | 説明 |
|---------|------|
| AIモデル | 使用されたAIモデル(例: openai, google) |
| モデルバージョン | 具体的なモデルバージョン(例: gpt-5, gemini-2.5-pro) |
| 回答テキスト | AIからの完全な回答 |

### スコアリングブロック(5カラム)

| カラム名 | 説明 |
|---------|------|
| 可視性スコア | 総合的な可視性スコア(0-100) |
| プレゼンススコア | ブランド言及の存在スコア(0-35) |
| ポジションスコア | 言及位置のスコア(0-35) |
| 引用スコア | 引用に関するスコア(0-30) |
| ブランド順位 | 回答内でのブランドの順位 |

### ブランド分析ブロック(6カラム)

| カラム名 | 説明 |
|---------|------|
| 言及有無 | ブランドが言及されたか(TRUE/FALSE) |
| 言及回数 | ブランドが言及された回数 |
| 言及箇所 | 言及された位置(カンマ区切り) |
| 抽出ブランド一覧 | 回答から抽出されたブランド名(カンマ区切り) |
| 競合ブランド一覧 | 言及された競合ブランド(カンマ区切り) |
| 抽出された特徴 | 抽出された製品特徴(カンマ区切り) |

### 引用分析ブロック(4カラム)

| カラム名 | 説明 |
|---------|------|
| 引用サイト数 | 引用されたWebサイトの数 |
| 引用サイトURL一覧 | 引用されたURL(カンマ区切り) |
| 自社サイト引用有無 | 自社Webサイトが引用されたか(TRUE/FALSE) |
| 自社サイト引用順位 | 自社サイトが引用された順位 |

## 活用例

### 1. カスタムスコアの計算

Answer IOの標準スコアとは異なる重み付けで独自スコアを計算できます。

**例: Perplexity専用スコア**

条件: AIモデルが "perplexity" の行のみを抽出 計算: 可視性スコアの平均値を算出


**例: 引用重視スコア**

条件: 自社サイト引用有無が TRUE の行を抽出 計算: (引用スコア × 2 + プレゼンススコア) / 2


### 2. ファネル別パフォーマンス分析

ファネル段階ごとにスコアを集計し、どの段階で強い/弱いかを分析できます。

**Excelでのピボットテーブル例**:

行: ファネル段階 列: AIモデル 値: 可視性スコアの平均


### 3. 競合比較分析

競合ブランド一覧カラムから、どの競合が頻繁に言及されているか分析できます。

**分析方法**:
1. 「競合ブランド一覧」カラムのデータを整形
2. 各競合ブランドの出現頻度をカウント
3. グラフ化して可視化

### 4. 時系列トレンド分析

複数回のレポートCSVを結合し、時系列でスコアの推移を追跡できます。

**手順**:
1. 各レポートのCSVをダウンロード
2. Excel/スプレッドシートで結合
3. 「実行日時」を基準に折れ線グラフを作成

### 5. BIツールでのダッシュボード作成

Tableau、Looker Studio、Power BIにインポートし、インタラクティブなダッシュボードを作成できます。

**Looker Studioでの例**:
1. データソースとしてCSVをアップロード
2. 日付フィールド: 「実行日時」
3. ディメンション: ファネル段階、AIモデル
4. 指標: 可視性スコア、言及回数
5. グラフ: スコアカード、時系列グラフ、円グラフ

## よくある質問

**Q: エクスポートしたCSVが文字化けします**
A: Excelで開く場合は、「データ」→「テキストから」→「UTF-8エンコーディング」を選択してください。

**Q: エクスポートできるデータ量に制限はありますか?**
A: 制限はありません。レポート実行に含まれるすべてのデータがエクスポートされます。

**Q: 過去のレポートもエクスポートできますか?**
A: はい、過去に実行したすべてのレポートからエクスポート可能です。

**Q: エクスポートにポイントは消費されますか?**
A: いいえ、CSVエクスポートにポイントは不要です。何度でも無料でエクスポートできます。

**Q: 定期的に自動エクスポートできますか?**
A: 現在は手動エクスポートのみです。定期エクスポート機能は今後追加予定です。
2. レポート作成ページへの追記

ファイル: ja/getting-started/create-report.md (既存ファイルに追記)

追加セクション:

markdown
## レポートデータのエクスポート

レポート実行後、結果データをCSV形式でエクスポートできます。エクスポートしたデータは、Excel・Google スプレッドシート・BIツールなどで自由に分析できます。

詳しくは[レポートデータをエクスポートする](/ja/getting-started/csv-export)をご覧ください。
3. 用語集への追加

ファイル: ja/glossary.md (既存ファイルに追記)

markdown
## CSVエクスポート

レポート実行結果のすべてのデータをCSV(Comma-Separated Values)形式でダウンロードする機能です。

### エクスポートされるデータ

- 24カラムの詳細データ
- クエリ情報、AI応答、スコア、ブランド分析、引用情報など

### 用途

- Excel・Google スプレッドシートでの分析
- BIツール(Tableau、Looker Studio等)との連携
- 独自指標の算出
- データアーカイブ

### 特徴

- ポイント消費なし
- 何度でもエクスポート可能
- UTF-8エンコーディング(Excel互換)

関連: [レポートデータをエクスポートする](/ja/getting-started/csv-export)

✅ 実装チェックリスト

  • [x] ja/getting-started/csv-export.md を新規作成 ✅ 完了 (2025-11-20)
    • [x] 機能概要とメリット
    • [x] エクスポート手順(ステップバイステップ)
    • [x] データカラムの詳細説明(全24カラム)
    • [x] 活用例(5パターン以上)
    • [x] Excelでの開き方の説明
    • [x] FAQセクション
    • [ ] スクリーンショット(エクスポートボタン、CSVファイルなど)⚠️ 要対応
  • [x] ja/getting-started/create-report.md に追記 ✅ 完了 (2025-11-20)
    • [x] CSVエクスポートへのリンク追加
  • [x] ja/glossary.md に用語追加 ✅ 完了 (2025-11-20)
    • [x] CSVエクスポートの定義
    • [x] まとめテーブルに追加
  • [x] ja/getting-started/index.md に項目追加 ✅ 完了 (2025-11-20)
    • [x] 学習順序に追加
  • [x] ナビゲーション設定の更新 ✅ 完了 (2025-11-20)
    • [x] .vitepress/config.ts のサイドバーに追加
  • [x] レビューと公開 🔍 一部完了
    • [x] データカラムの説明が正確か確認(実装コードと照合済み)
    • [x] 活用例が実用的か確認
    • [ ] スクリーンショットの追加 ⚠️ スクリーンショット未追加
    • [ ] リンク切れチェック ⚠️ 要確認

🔍 実装確認結果 (2025-11-20)

実装コードとの照合を完了しました。

確認したファイル
  • backend/app/api/v1/report_export.py - CSVエクスポートAPIエンドポイント
  • backend/app/services/report_export_service.py - データ取得とCSV生成ロジック
  • backend/app/utils/csv_generator.py - CSVフォーマット処理(24カラム定義)
  • frontend/app/dashboard/reports/[batchId]/components/ExportButton.tsx - エクスポートボタンUI
  • frontend/lib/api/report-export.ts - APIクライアント
確認結果

✅ 正確性が確認された項目:

  • APIエンドポイント(GET /api/v1/reports/batch/{batch_id}/export/csv
  • 24カラムの完全なリスト(基本情報6、AI応答3、スコア5、ブランド分析6、引用分析4)
  • UTF-8 BOM エンコーディング(Excel互換性のため)
  • ファイル名形式(report_raw_data_{batch_id}_{YYYYmmdd_HHMMSS}.csv
  • ストリーミング処理(100行単位のバッチ処理)
  • Parse Worker完了確認(エクスポート前提条件)
  • データ量制限なし
  • ポイント消費なし

📝 ドキュメント作成内容:

  1. 24カラムを5つのブロックに分類して説明
  2. エクスポート手順を3ステップで解説
  3. 5つの具体的な活用例(カスタムスコア計算、ファネル別分析、競合比較、時系列トレンド、BIツール連携)
  4. Excel/Google スプレッドシートでの開き方を詳細に記載
  5. FAQセクションで7つの質問に回答

⚠️ 残タスク:

  • スクリーンショットの追加(CSVエクスポートボタン、ダウンロード画面、Excelで開いたCSVサンプル)
  • リンク切れチェック
  • ステージング環境での実機確認
データベースクエリ詳細

データ取得SQL構造:

python
select(RunModel, Query, Answer, Brand)
  .join(Query, RunModel.query_id == Query.id)
  .join(Answer, Answer.run_id == RunModel.id)
  .outerjoin(Brand, Query.brand_id == Brand.id)
  .filter(RunModel.batch_id == batch_id)
  .filter(RunModel.tenant_id == tenant_id)
  .order_by(RunModel.created_at.asc(), Query.query_text.asc(), Answer.ai_model.asc())

前提条件チェック:

  1. バッチが存在し、テナントに属している
  2. すべてのRun状態が "completed" または "failed"
  3. Parse Worker処理完了(answer.mention_count IS NOT NULL
CSVカラムとデータソースのマッピング
カラムデータソース備考
レポート実行IDRun.batch_idUUID形式
実行日時Run.completed_atISO 8601 (JST)
ファネル段階Query.funnel_stageFUNNEL_LABELS辞書で日本語翻訳
クエリIDQuery.id文字列化
クエリテキストQuery.query_textテキストクリーニング適用
クエリタイプQuery.query_type直接
AIモデルAnswer.ai_model直接
モデルバージョンAnswer.model_version直接
回答テキストAnswer.response_text\n\\n変換
可視性スコアAnswer.visibility_score0-100
プレゼンススコアAnswer.scoring_details.presence.scoreJSON抽出
ポジションスコアAnswer.scoring_details.position.scoreJSON抽出
引用スコアAnswer.scoring_details.citation.scoreJSON抽出
ブランド順位Answer.scoring_details.position.rankJSON抽出
言及有無Answer.brand_mentionedTRUE/FALSE変換
言及回数Answer.mention_count整数
言及箇所Answer.mention_locations[].textカンマ区切りリスト
抽出ブランド一覧Answer.extracted_entities[]type="brand"でフィルタ
競合ブランド一覧Answer.competitors_mentioned[]名前フィールドを抽出
抽出された特徴Answer.extracted_entities[].attributes.featuresブランドエンティティの特徴
引用サイト数len(Answer.sources_cited)リスト長
引用サイトURL一覧Answer.sources_cited[].urlカンマ区切りリスト
自社サイト引用有無Brand.websites + Answer.sources_citedドメイン照合
自社サイト引用順位Answer.sources_cited 内の位置1ベース番号

💡 作成時の注意点

  1. データカラムの説明は正確に:

    • answer-io-standalone/docs/features/report-raw-data-export.md の「エクスポート対象データ」セクションを参照
  2. 実際のCSVファイルを確認:

    • ステージング環境で実際にエクスポートして、カラム名や形式を確認
  3. 活用例は具体的に:

    • 単なる「分析できます」ではなく、具体的な手順やExcel関数の例を含める
  4. スクリーンショット:

    • エクスポートボタンの位置
    • ダウンロード中の画面
    • Excelで開いたCSVファイルのサンプル

🟡 優先度: 中

3. AIモデルバージョン管理

📍 現状

  • ✅ 機能実装済み
  • ✅ 技術ドキュメント作成済み
  • ✅ プレスリリース発行済み(GPT-5.1、Gemini 3対応)
  • ⚠️ ユーザーマニュアルに一部言及あり(クエリ作成ページ)
  • ❌ 詳細なガイド未作成

📚 参照元ドキュメント

主要ドキュメント:

  • answer-io-standalone/docs/features/model-version-management-implementation.md - 実装方針書
  • answer-io-standalone/docs/press/フィードフォース、「Answer IO」が最新AIモデル「GPT-5.1」「Gemini 3」に対応、最新モデルでのブランド可視性を測定可能に.md - プレスリリース

関連コミット:

  • 1c39ed1d - AIモデルバージョン管理 (:latest エイリアス対応)
  • 8cfbb0c9 - モデルバージョン管理システム実装
  • 9ad2d373 - ModelSelector と RankingSection コンポーネントのリファクタリング

📝 ユーザーマニュアルに追加すべき内容

1. クエリ作成ページへの追記

ファイル: ja/getting-started/create-query.md (既存ファイルに追記)

追加セクション:

markdown
## AIモデルのバージョン選択

クエリを作成する際、各AIモデルのバージョンを選択できます。

### バージョンの種類

#### 最新モデルを自動使用(推奨)✨

新しいAIモデルがリリースされた際、自動的に最新バージョンに切り替わります。

**メリット**:
- 常に最新の性能で測定
- 設定変更不要
- 日常的なブランド監視に最適

**表示**:
- モデル選択画面: 「OpenAI (最新モデルを自動使用)」
- 実行履歴: 実際に使用されたバージョンが表示される(例: gpt-5.1)

#### 固定バージョン

特定のAIモデルバージョンに固定します。

**メリット**:
- 過去データとの正確な比較
- モデル変更による影響を避ける
- 再現性の高い測定

**表示**:
- モデル選択画面: 「OpenAI GPT-5.1 (固定)」
- 実行履歴: 固定バージョンが表示される

### 用途別の推奨設定

| 用途 | 推奨設定 | 理由 |
|------|---------|------|
| 日常的なブランド監視 | 最新モデルを自動使用 | 常に最新の性能で測定できる |
| 過去データとの比較 | 固定バージョン | モデル変更の影響を排除できる |
| 新モデルの性能テスト | 両方を並行実行 | 新旧モデルのパフォーマンス比較 |

### モデルバージョンの確認方法

実行履歴では、実際に使用されたモデルバージョンを確認できます。

**確認手順**:
1. クエリ詳細ページを開く
2. 「実行履歴」セクションを確認
3. 各実行の「モデル」カラムにバージョンが表示されます

**表示例**:
- 最新モデル使用時: 「gpt-5.1」(✨マーク付き)
- 固定バージョン使用時: 「gpt-5」

### 新モデルリリース時の動作

新しいAIモデルがリリースされた場合:

**「最新モデルを自動使用」の場合**:
- 次回のクエリ実行から自動的に新モデルが使用されます
- ダッシュボードに通知が表示されます

**「固定バージョン」の場合**:
- 引き続き指定したバージョンが使用されます
- 新モデルへの切り替えは手動で行えます

::: tip 推奨事項
多くの場合、「最新モデルを自動使用」の設定で問題ありません。特定のバージョンでの比較が必要な場合のみ、固定バージョンを使用してください。
:::
2. 用語集への追加

ファイル: ja/glossary.md (既存ファイルに追記)

markdown
## AIモデルバージョン

クエリ実行時に使用されるAIモデルの特定のバージョンです。

### バージョン管理の種類

#### 最新モデルを自動使用

新しいモデルがリリースされると、自動的に最新バージョンに切り替わる設定です。`:latest` エイリアスとも呼ばれます。

**例**:
- 設定: `openai:latest`
- 実行時に使用されるモデル: `gpt-5.1`(最新版)
- 新モデルリリース後: `gpt-5.2`(自動切り替え)

#### 固定バージョン

特定のモデルバージョンに固定する設定です。

**例**:
- 設定: `openai:gpt-5`
- 実行時に使用されるモデル: 常に `gpt-5`

### 対応モデル

| プロバイダー | 最新モデル | 固定バージョン例 |
|------------|----------|----------------|
| OpenAI | gpt-5.1 | gpt-5.1, gpt-5, gpt-4o |
| Google | gemini-3-pro-preview | gemini-3-pro-preview, gemini-2.5-pro, gemini-2.0-flash-exp |
| Anthropic | claude-3-5-sonnet-20241022 | claude-3-5-sonnet-20241022 |
| Perplexity | sonar | sonar |

関連: [クエリを作成する](/ja/getting-started/create-query#aiモデルのバージョン選択)

✅ 実装チェックリスト

  • [ ] ja/getting-started/create-query.md に詳細セクション追加
    • [ ] バージョンの種類の説明
    • [ ] 用途別推奨設定の表
    • [ ] モデルバージョン確認方法
    • [ ] 新モデルリリース時の動作説明
    • [ ] スクリーンショット(モデル選択画面、実行履歴)
  • [ ] ja/glossary.md に用語追加
    • [ ] AIモデルバージョンの定義
    • [ ] 対応モデル一覧表
  • [ ] レビューと公開
    • [ ] 技術的な正確性確認
    • [ ] ユーザーにわかりやすい表現か確認

💡 作成時の注意点

  1. 技術用語を避ける:

    • 「:latestエイリアス」ではなく「最新モデルを自動使用」
    • ユーザー視点での説明を心がける
  2. 具体例を多用:

    • 抽象的な説明ではなく、具体的なモデル名を使った例
  3. ビジュアル要素:

    • モデル選択UIのスクリーンショット
    • 実行履歴でのバージョン表示のスクリーンショット

🟢 優先度: 低(将来対応)

4. その他の小規模な更新

ポイント消費情報の更新

ファイル: ja/getting-started/points.md

更新内容:

  • 改善提案生成時のポイント消費(レポートサイズによる)
  • CSVエクスポートはポイント消費なし(明記)

ブランディング用語の更新

対象: 全ドキュメント

更新内容:

  • 「AIO」→「AEO」への用語変更(コミット: 721b8e2b
  • ただし、ユーザーマニュアルには「AIO」という用語がほとんど使われていないため影響は小さい

📅 実装スケジュール案

Week 1: Google Analytics連携

  • Day 1-2: ja/getting-started/google-analytics.md 作成
  • Day 3: スクリーンショット撮影・追加
  • Day 4: 用語集・ナビゲーション更新
  • Day 5: レビュー・修正

Week 2: CSVエクスポート

  • Day 1-2: ja/getting-started/csv-export.md 作成
  • Day 3: データカラム説明・活用例作成
  • Day 4: スクリーンショット・サンプルCSV追加
  • Day 5: レビュー・修正

Week 3: AIモデルバージョン管理

  • Day 1-2: ja/getting-started/create-query.md 更新
  • Day 3: 用語集更新
  • Day 4: スクリーンショット追加
  • Day 5: 最終レビュー・公開

🔍 品質チェックリスト

各ドキュメント作成時に以下を確認してください:

内容の正確性

  • [ ] 技術ドキュメント(サブモジュール)の内容と一致しているか
  • [ ] ステージング環境で実際に操作して手順を確認したか
  • [ ] スクリーンショットは最新のUIか

ユーザビリティ

  • [ ] 初心者でも理解できる平易な表現か
  • [ ] ステップバイステップの手順が明確か
  • [ ] スクリーンショットは適切な位置に配置されているか
  • [ ] 専門用語には説明やリンクがあるか

構成

  • [ ] 見出し階層が適切か
  • [ ] 目次(VitePress自動生成)が見やすいか
  • [ ] 関連ページへのリンクが適切に配置されているか
  • [ ] FAQセクションがあるか

SEO・検索性

  • [ ] ページタイトルが明確か
  • [ ] メタディスクリプション(frontmatter)が適切か
  • [ ] 検索で見つけやすいキーワードが含まれているか

コンプライアンス

  • [ ] 誤解を招く表現がないか
  • [ ] セキュリティ・プライバシーに関する記述が適切か
  • [ ] 免責事項が必要な箇所に記載されているか

📚 参考リソース

サブモジュールの参照先

  • 技術ドキュメント: answer-io-standalone/docs/
  • プレスリリース: answer-io-standalone/docs/press/
  • 機能仕様: answer-io-standalone/docs/features/

既存のユーザーマニュアル

  • VitePress設定: .vitepress/config.ts
  • 既存ページ: ja/getting-started/
  • 用語集: ja/glossary.md

スタイルガイド

  • 既存のドキュメントページ(ja/getting-started/配下)のトーンとスタイルに合わせる
  • 親しみやすく、実用的な説明を心がける
  • スクリーンショットは最低限必要な箇所に配置

✅ 完了の定義

各機能のドキュメント化は、以下の条件を満たした時点で「完了」とみなします:

  1. 新規ページ作成

    • 該当する.mdファイルが作成され、内容が充実している
    • スクリーンショットが適切に配置されている
  2. 既存ページ更新

    • 関連する既存ページに必要な情報が追記されている
    • リンクが適切に設定されている
  3. ナビゲーション設定

    • .vitepress/config.tsのサイドバーに追加されている
    • 適切な順序で配置されている
  4. 用語集更新

    • 新しい用語がja/glossary.mdに追加されている
    • 相互リンクが設定されている
  5. 品質チェック完了

    • 上記「品質チェックリスト」の全項目がチェック済み
    • 少なくとも1名以上によるレビュー完了
  6. デプロイ確認

    • ステージング環境での表示確認
    • リンク切れチェック完了
    • 本番環境へのデプロイ完了

📞 サポート

このドキュメントに関する質問や、作業中に不明な点があれば以下に連絡してください:

  • 技術的な質問: サブモジュール(answer-io-standalone)の技術ドキュメントを参照
  • UIの確認: ステージング環境で実際に操作
  • レビュー依頼: PRを作成して共有

📝 作業履歴

2025-11-20: Google Analytics連携機能ドキュメント作成完了

実施内容:

  1. 新規ページ作成

    • ja/getting-started/google-analytics.md を作成
    • 機能概要、設定方法、データの見方、トラブルシューティング、FAQを含む包括的なガイド
  2. 既存ページ更新

    • ja/glossary.md: Google Analytics連携の用語を追加
    • ja/getting-started/index.md: 学習順序に「Google Analytics連携」を追加
    • .vitepress/config.ts: サイドバーナビゲーションに追加
  3. 実装確認

    • サブモジュール(answer-io-standalone)の実装コードを詳細確認
    • APIエンドポイント、データベースモデル、OAuth認証フロー、AI検索エンジン検知ロジックを検証
    • ドキュメント内容が実装と完全に一致していることを確認
  4. ドキュメント修正

    • AI検索エンジンリストを8種類に拡充(You.com、Bing Chat を追加)
    • データ同期の説明を「リアルタイム表示(推奨)」に更新
    • FAQセクションを実装に基づいて修正

確認した実装ファイル:

  • backend/app/api/v1/brand_analytics.py - 11個のAPIエンドポイント
  • backend/app/db/models/brand_analytics.py - 2つのテーブル定義
  • backend/app/services/google_analytics.py - GA4連携ロジック(8種類のAI検索エンジン検知)
  • frontend/hooks/useAnalytics.ts - React Hooks実装

残タスク:

  • スクリーンショットの追加(GA連携ボタン、認証画面、プロパティ選択、データ表示)
  • リンク切れチェック
  • ステージング環境での実機確認

成果物:

  • 約250行の包括的なユーザーガイド
  • 実装コードと100%一致した正確な内容
  • ユーザーフレンドリーなステップバイステップ説明

2025-11-20: CSVエクスポート機能ドキュメント作成完了

実施内容:

  1. 新規ページ作成

    • ja/getting-started/csv-export.md を作成
    • 機能概要、エクスポート方法、データ詳細、活用例、FAQを含む包括的なガイド
  2. 既存ページ更新

    • ja/getting-started/create-report.md: CSVエクスポートへのリンクとセクションを追加
    • ja/glossary.md: CSVエクスポートの用語を追加、まとめテーブルにも追加
    • ja/getting-started/index.md: 学習順序にCSVエクスポートを追加(7番目)
    • .vitepress/config.ts: サイドバーナビゲーションに追加
  3. 実装確認

    • サブモジュール(answer-io-standalone)の実装コードを詳細確認
    • APIエンドポイント、CSV生成ロジック、24カラム定義、フロントエンド実装を検証
    • ドキュメント内容が実装と完全に一致していることを確認
  4. ドキュメント内容

    • 24カラムを5つのブロックに分類(基本情報、AI応答、スコアリング、ブランド分析、引用分析)
    • エクスポート手順を3ステップで解説
    • 5つの具体的な活用例(カスタムスコア計算、ファネル別分析、競合比較、時系列トレンド、BIツール連携)
    • Excel/Google スプレッドシートでの開き方を詳細に記載
    • FAQセクションで7つの質問に回答

確認した実装ファイル:

  • backend/app/api/v1/report_export.py - CSVエクスポートAPIエンドポイント
  • backend/app/services/report_export_service.py - データ取得とCSV生成サービス
  • backend/app/utils/csv_generator.py - CSV生成ロジック(24カラム定義)
  • frontend/app/dashboard/reports/[batchId]/components/ExportButton.tsx - エクスポートボタンUI
  • frontend/lib/api/report-export.ts - APIクライアント

確認した技術詳細:

  • APIエンドポイント: GET /api/v1/reports/batch/{batch_id}/export/csv
  • ファイル名形式: report_raw_data_{batch_id}_{YYYYmmdd_HHMMSS}.csv
  • UTF-8 BOM エンコーディング(Excel互換性のため)
  • ストリーミング処理(100行単位のバッチ処理)
  • Parse Worker完了確認(エクスポート前提条件)
  • データ量制限なし、ポイント消費なし

残タスク:

  • スクリーンショットの追加(CSVエクスポートボタン、ダウンロード画面、Excelで開いたCSVサンプル)
  • リンク切れチェック
  • ステージング環境での実機確認

成果物:

  • 約300行の包括的なユーザーガイド
  • 実装コードと100%一致した正確な内容
  • 5つの実践的な活用例とExcel関数サンプル
  • ユーザーフレンドリーなステップバイステップ説明

最終更新: 2025-11-20 バージョン: 1.2

最終更新:

Answer IO - AI検索でのブランドスコアを見える化