FactVerse AI Agent 文件庫架構
目前 FactVerse AI Agent 頁面適合作為概覽材料,但還不能算完整的使用文件庫。它們說明了平台是什麼、適用於哪些場景,但還沒有系統說明如何接入、設定、操作、驗收、排錯和治理 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 被拒絕
│ ├── 來源資料缺失或過期
│ ├── 工具呼叫逾時
│ ├── 寫操作被阻止
│ └── 模擬任務失敗
└── 治理與驗收
├── 租戶邊界
├── 審批策略
├── 證據和引用要求
├── 部署驗收清單
└── 營運交接清單
頁面內容契約
不同類型的頁面必須承擔不同職責。
| 頁面類型 | 必須包含 | 需要分開的內容 |
|---|---|---|
| 概覽 | 產品邊界、目標讀者、穩定入口 | 市場頁面或發布說明 |
| 概念 | 心智模型、實體、邊界和適用條件 | 模糊的能力宣傳 |
| 快速開始 | 所需權限、明確步驟、預期結果、驗證命令 | 冗長的架構文章 |
| 整合指南 | 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 客戶端。
- 發起第一次工具呼叫並驗證回應。
- 至少完成一個從輸入資料到人工複核輸出的完整工作流。
- 能夠根據公開文件處理常見失敗路徑。
- 驗證部署就緒和交接要求。