- 新增 `middleware-versions.md` 作为标准版本参考文档 - 在技能指南中更新资源引用,添加版本清单问答规范 - 明确 Web Server 与 AP Server 的角色划分及输出要求
7.2 KiB
7.2 KiB
name, description
| name | description |
|---|---|
| g3fo-docs | g3fo 系统相关文档。管理业务流程说明、服务职责定义、中间件标准部署、系统初始化规范,以及跨环境(Dev/UAT)和多客户的资产清单。支持差异化配置查询与业务逻辑问答。 |
g3fo 系统相关文档 (g3fo-docs)
本 Skill 采用“标准模板 + 客户清单”的架构,并整合了业务流程与服务职责,旨在帮助 AI 快速理解并回答复杂的系统业务问题。
1. 查找指南
- 查业务流程:查阅
references/business_flows/(如订单生命周期、用户入金等跨服务流程)。 - 查服务职责:查阅
references/services/(如g3fo-trade-service.md定义的具体功能)。 - 查架构概览:查阅
references/architecture/domain_overview.md。 - 分析测试流程:参考
references/business_flows/_TEST_FLOW_TEMPLATE.md。 - 查标准运维流程:去
references/middleware/或references/system-init/。 - 查中间件总览/高可用架构:查阅
references/middleware/middleware-comprehensive-guide.md。 - 查中间件与标准组件版本:查阅
references/middleware/middleware-versions.md(含g3fo-*-service应用版本、中间件与 JDK;Web Server 仅 Nginx / Vue / Flutter,其余为 AP Server;用户要「所有版本」时须分两类列出,见 §2.D)。 - 查具体环境/客户资产:
- 内部环境(Dev/UAT):查阅
references/inventory/internal.md。 - 外部客户(客户A、B等):查阅
references/inventory/clients/[客户名].md。
- 内部环境(Dev/UAT):查阅
2. 问答逻辑 (AI 引导)
A. 业务逻辑问答
- 识别范围:判断用户问题涉及哪些业务流程 or 服务。
- 加载文档:
- 优先查找
business_flows/下的相关流程文档。 - 结合
services/下涉及的服务文档,深入了解具体职责。
- 优先查找
- 关联分析:
- 使用流程文档中的 Mermaid 时序图理解服务间的交互。
- 如果用户问及“某个功能由谁负责”,查阅
architecture/domain_overview.md确认所属域。
- 回答准则:
- 基于事实:仅根据已有的 Markdown 文档回答。
- 明确边界:如果文档中没有相关说明,必须回答:“根据现有文档,我无法确定 [具体业务点] 的实现细节,建议查阅代码或询问开发人员。”
B. 运维配置生成
- 识别主体:确定用户问的是哪个环境或哪个客户。
- 组合信息:
- 读取资产变量:优先读取客户专属文件(如
clients/client_a.md)或内部清单(internal.md)中的“变量定义”表格。 - 读取部署模版:读取
middleware/下的标准部署文档(如keepalived/deploy.md)。 - 变量替换:将部署文档中的
${VARIABLE_NAME}占位符替换为资产清单中对应的值。
- 读取资产变量:优先读取客户专属文件(如
- 输出要求:
- 环境标注:在提供客户配置时,必须明确标注该配置适用于哪个特定环境,防止误操作。
- 完整配置:如果用户要求生成特定节点的配置文件,请直接输出替换后的完整配置内容。
- MySQL 命令规范:
- 强制包含 Host:所有
docker exec执行的mysql命令必须显式包含-h127.0.0.1参数,以确保在容器内连接成功。 - 双格式输出:当提供 SQL 修复或查询脚本时,必须同时提供以下两种格式:
- 格式 A (Docker 模式):完整的
docker exec -it mysql mysql -uroot -pafe123456 -h127.0.0.1 -e "SQL_CONTENT"。 - 格式 B (纯 SQL 模式):仅包含 SQL 语句本身,方便在 GUI 工具中执行。
- 格式 A (Docker 模式):完整的
- 强制包含 Host:所有
C. 测试流程分析 (New)
- 需求解析:识别用户提出的业务关键词(如“下单”、“撤单”、“充值”)。
- 文档检索:
- 查找
business_flows/下的业务流程文档。 - 查找
services/下涉及的服务定义。
- 查找
- 代码溯源:
- 根据文档中提到的服务,在项目中搜索对应的 Controller、Service 或核心逻辑代码。
- 重点搜索路径:
- REST 接口:
com.afe.g3fo.*.controller或com.afe.g3fo.*.api。 - Dubbo 接口:
com.afe.g3fo.*.facade(定义)及com.afe.g3fo.*.facade.impl(实现)。
- REST 接口:
- 重点搜索注解:
@RequestMapping,@PostMapping,@GetMapping,@Service,@DubboService等。
- 表格生成:汇总信息,输出包含“步骤”、“涉及服务”、“关键接口/代码逻辑”、“测试内容/预期结果”的表格。
- 格式参考:
references/business_flows/_TEST_FLOW_TEMPLATE.md。
- 格式参考:
D. 版本清单问答
- 文档来源:以
references/middleware/middleware-versions.md为唯一标准版本表(除非用户指定环境资产清单覆盖)。 - 角色区分:
- Web Server:仅 Nginx、Vue、Flutter。
- AP Server:全部
g3fo-*-service、全部中间件(MySQL、Redis、RocketMQ、Nacos、PowerJob、Beszel、Dozzle、dufs 等)、OpenJDK。
- 用户问「所有版本 / 完整版本 / 各组件版本号」等:必须分两块输出,且标题或小节名明确为 Web Server 与 AP Server(可先 Web 后 AP,或先 AP 后 Web,但两类不可混为一张无标签表)。
3. 示例 Prompt (用户可参考)
- 业务咨询:
- “我想测试下单业务流程,请分析代码并列出详细的测试步骤表格。”
- “g3fo 系统中,一个订单从下单到成交会经过哪些服务?请结合
references/business_flows/下的相关文档回答。” - “
g3fo-margin-service负责哪些核心逻辑?它的上下游依赖是谁?”
- 部署配置:
- “请结合
references/inventory/internal.md中的UAT环境变量,参考references/middleware/keepalived/deploy.md部署文档,为我生成 Node A 的keepalived.conf配置文件。” - “请根据
references/middleware/middleware-comprehensive-guide.md和references/middleware/nacos/deploy.md,结合客户资产清单生成 Nacos 部署配置。”
- “请结合
- 故障排查:
- “我的 MySQL 出现了复制冲突,报错
Duplicate entry,请根据references/middleware/mysql/fault-analysis.md提供排查脚本 and 修复建议。”
- “我的 MySQL 出现了复制冲突,报错
- 版本清单:
- “请根据
middleware-versions.md列出当前约定的全部组件版本,并按 Web Server / AP Server 分开。”
- “请根据
4. 资源地图
- 业务与服务:
- 服务职责:
services/(g3fo-trade-service, g3fo-margin-service 等) - 跨服务流程:
business_flows/(订单生命周期等) - 架构概览:
architecture/domain_overview.md
- 服务职责:
- 中间件标准(部署/故障分析等详见各子目录):
- 总览:
middleware/middleware-comprehensive-guide.md - 版本清单:
middleware/middleware-versions.md(Web:Nginx/Vue/Flutter;AP:g3fo-*-service+ 中间件 + JDK) - Keepalived:
middleware/keepalived/ - MySQL:
middleware/mysql/ - Nacos:
middleware/nacos/ - PowerJob:
middleware/powerjob/ - Redis:
middleware/redis/ - RocketMQ:
middleware/rocketmq/ - Stunnel4:
middleware/stunnel4/
- 总览:
- 系统规范: 内核优化, 安全加固...
- 资产清单: 内部测试机, 客户生产环境...