FactVerse AI Agent ドキュメントアーキテクチャ
現在の FactVerse AI Agent ページは概要資料としては有用ですが、まだ完全な利用ドキュメントライブラリではありません。プラットフォームの概要や適用領域は説明していますが、接続、設定、運用、検証、トラブルシューティング、ガバナンスを体系的に案内できていません。
このページでは、FactVerse AI Agent ドキュメントセットの目標構造を定義します。
現在のページの位置づけ
| 現在のページ | 残す位置づけ | 理由 |
|---|---|---|
| FactVerse AI Agent | 概要 | 製品境界、名称ルール、入口リンクを示す。 |
| アーキテクチャ | コンセプト | Agent が FactVerse Platform、DFS、Designer、Inspector、MCP、知識、シミュレーションとどう接続するかを示す。 |
| ケイパビリティマップ | コンセプト | 製品コンポーネントとツールを顧客が理解できる能力へ対応づける。 |
| ユースケース | コンセプトとロードマップ | 優先ワークフロー領域を示し、手順はワークフローガイドへ接続する。 |
| 施設運用 | ワークフローコンセプト | 運用シナリオと期待出力を説明し、タスク指向ワークフローガイドへ接続する。 |
| 予知保全 | ワークフローコンセプト | 保全シナリオと証拠整理のパターンを説明し、タスク指向ワークフローガイドへ接続する。 |
| Physical AI | ワークフローコンセプト | Designer、SimReady asset、シミュレーション、フィードバックループを説明し、タスク指向ワークフローガイドへ接続する。 |
これらのページはコンセプトとして残し、実装手順はタスク指向ワークフローガイドで扱います。
目標構造
FactVerse AI Agent
├── 概要
├── ドキュメント構成
├── はじめに
│ ├── 前提条件
│ ├── 認証とスコープ
│ ├── MCP クライアント接続
│ ├── 最初のツール呼び出し
│ └── セットアップ検証
├── コアコンセプト
│ ├── テナント、アセット、権限コンテキスト
│ ├── ツール、scope、監査記録
│ ├── 人による承認と書き込み操作
│ ├── データ準備状況と参照元
│ └── デジタルツイン、シーン、シミュレーションコンテキスト
├── 接続ガイド
│ ├── MCP クライアント接続
│ ├── エンタープライズ Agent 接続
│ ├── クラウドデプロイモデル
│ ├── オンプレミスデプロイモデル
│ ├── ハイブリッドデプロイモデル
│ └── Key ローテーションとシークレット管理
├── ワークフローガイド
│ ├── 施設運用
│ │ ├── アセットと施設コンテキストの準備
│ │ ├── 運用シグナルの接続
│ │ ├── 運用サマリーの生成
│ │ └── Inspector ワークオーダードラフトの準備
│ ├── 予知保全
│ │ ├── 設備履歴の準備
│ │ ├── シグナル品質の確認
│ │ ├── リスク説明の生成
│ │ └── 保全チェックフローの作成
│ └── Physical AI
│ ├── Designer シーンの準備
│ ├── SimReady asset の作成
│ ├── シミュレーション向けレビューの実行
│ └── 検証結果を Agent ワークフローへ戻す
├── リファレンス
│ ├── ツールリファレンス
│ ├── Scope リファレンス
│ ├── リクエストとレスポンス例
│ ├── エラーコード
│ └── 監査イベントリファレンス
├── トラブルシューティング
│ ├── 認証失敗
│ ├── Scope denied
│ ├── 参照元データの欠落または古さ
│ ├── ツールタイムアウト
│ ├── 書き込み操作のブロック
│ └── シミュレーションジョブ失敗
└── ガバナンスと検証
├── テナント境界
├── 承認ポリシー
├── 証拠と引用の期待値
├── デプロイ受け入れチェックリスト
└── 運用引き継ぎチェックリスト
ページ内容の契約
ページ種別ごとに役割を分けます。
| ページ種別 | 必須内容 | 分けて扱う内容 |
|---|---|---|
| 概要 | 製品境界、対象読者、安定した入口 | マーケティングページやリリースノート |
| コンセプト | メンタルモデル、エンティティ、境界、利用条件 | あいまいな機能紹介 |
| はじめに | 必要なアクセス、明確な手順、期待結果、検証コマンド | 長いアーキテクチャ論 |
| 接続ガイド | Endpoint、認証、scope、環境設定、例、失敗パターン | 製品紹介ページ |
| ワークフローガイド | 前提条件、手順、入力出力、レビュー点、ロールバックまたは次の操作 | 手順のないユースケース説明 |
| リファレンス | 安定したフィールド名、パラメータ、scope、レスポンス、エラー、生成元 | 叙述的なガイド |
| トラブルシューティング | 症状、想定原因、確認方法、修正方法、エスカレーション先 | 一般的な FAQ |
| ガバナンス | 承認境界、監査記録、保持、リスク注記、人の責任 | 法務またはコンプライアンスの過剰表現 |
優先構築順
- はじめに：認証、scope、MCP 接続、最初のツール呼び出し、セットアップ検証。
- コアコンセプト：テナントコンテキスト、アセットコンテキスト、管理されたツール、承認、監査、参照元。
- 優先ワークフローガイド：施設運用、予知保全、Physical AI。初版ガイドは追加済みで、今後は例とトラブルシューティングを拡張します。
- リファレンス拡張：例、エラーコード、監査イベント、生成ツールカタログへのクロスリンク。
- トラブルシューティング：接続、権限、データ、シミュレーションの一般的な失敗パス。
- デプロイと検証：クラウド、オンプレミス、ハイブリッド、受け入れチェックリスト、引き継ぎチェックリスト。
多言語展開
英語をアーキテクチャと接続詳細のソース言語とします。簡体字中国語、繁体字中国語、日本語は、公開ナビゲーションページと優先利用ページでは同じ変更内で公開します。Tier 2 言語は、保守する価値がある実装内容が揃ってからサイドバーに追加します。
境界
- 成熟している MCP ドキュメントは維持し、AI Agent ドキュメントをその周辺に拡張する。
- 顧客向けワークフロードキュメントは成熟したモジュールに集中する。
- 施設運用、予知保全、Physical AI を優先する。
- legacy FactVerse AI / FAI は旧モジュール資料として明確に扱う。
- Agent 出力の標準パターンは承認、監査、参照元を含み、運用判断は責任を持つ担当者が確認する。
ドキュメントライブラリの完了基準
顧客または実装エンジニアが次を実行できる状態になったとき、AI Agent セクションは実用的なドキュメントライブラリになります。
- 必要なアクセス権と接続元システムを理解できる。
- 正しい endpoint と scope で MCP クライアントを接続できる。
- 最初のツール呼び出しを実行し、レスポンスを検証できる。
- 入力データから人がレビューする出力まで、少なくとも一つの完全なワークフローを実行できる。
- 一般的な失敗パスを内部サポートなしで処理できる。
- デプロイ準備状況と引き継ぎ要件を確認できる。