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 客户端。
- 发起第一次工具调用并验证响应。
- 至少完成一个从输入数据到人工复核输出的完整工作流。
- 能够根据公开文档处理常见失败路径。
- 验证部署就绪和交接要求。